WPI GDC CMS 0.0.1
A B C D E F G H I L M N O P R S T U V W X

A

ACL - class org.wpi.gdc.cms.main.ACL.
An Access Control List.
ACL() - Constructor for class org.wpi.gdc.cms.main.ACL
 
ACLEntry - class org.wpi.gdc.cms.main.ACLEntry.
An Access Control List entry.
ACLEntry() - Constructor for class org.wpi.gdc.cms.main.ACLEntry
 
ACLGroupEntry - class org.wpi.gdc.cms.main.ACLGroupEntry.
An Access Control List entry.
ACLGroupEntry() - Constructor for class org.wpi.gdc.cms.main.ACLGroupEntry
 
ACLUserEntry - class org.wpi.gdc.cms.main.ACLUserEntry.
An Access Control List entry.
ACLUserEntry(User) - Constructor for class org.wpi.gdc.cms.main.ACLUserEntry
 
Attribute - class org.wpi.gdc.xml.Attribute.
The Java equivilent of a struct, containing publically accessible name and value information about an XML attribute.
Attribute(String, String) - Constructor for class org.wpi.gdc.xml.Attribute
 

B

bool - Variable in class org.wpi.gdc.cms.db.Restriction
Boolean to the next restriction in the chain.
bool_not - Variable in class org.wpi.gdc.cms.db.Restriction
When true, signifies that the boolean logic for this restriction should be reversed; otherwise, the boolean logic is normal.
BOOLEAN_AND - Static variable in class org.wpi.gdc.cms.db.Restriction
Boolean AND operator.
BOOLEAN_OR - Static variable in class org.wpi.gdc.cms.db.Restriction
Boolean OR operator.

C

callback - Variable in class org.wpi.gdc.xml.LiteXML
The callback that receives events.
canRemove() - Method in interface org.wpi.gdc.cms.db.DBIterator
Returns true if the Iterator supports the remove() call, false if it does not.
characters(char[], int, int) - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
characters(char[], int, int) - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.
checkUser(User) - Method in class org.wpi.gdc.cms.main.ACLEntry
Determines if the User object passed has permissions that come from this ACL.
checkUser(User) - Method in class org.wpi.gdc.cms.main.ACLUserEntry
Determines if the User object passed has permissions that come from this ACL.
checkUser(User) - Method in class org.wpi.gdc.cms.main.ACLGroupEntry
Determines if the User object passed has permissions that come from this ACL.
checkUserExists(int) - Method in class org.wpi.gdc.cms.main.Session
Returns false.
checkUserExists(User) - Method in class org.wpi.gdc.cms.main.Session
Returns false.
comment(char[], int, int) - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
comment(char[], int, int) - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.
COMPARE_EXACT - Static variable in class org.wpi.gdc.cms.db.StringRestriction
The EXACT mode
COMPARE_LIKE - Static variable in class org.wpi.gdc.cms.db.StringRestriction
The LIKE mode.
compare_mode - Variable in class org.wpi.gdc.cms.db.StringRestriction
The comparison mode, either StringRestriction.COMPARE_LIKE or StringRestriction.COMPARE_EXACT.
Config - class org.wpi.gdc.cms.main.Config.
This class represents the configuration of the current CMS session.
Config() - Constructor for class org.wpi.gdc.cms.main.Config
Creates a new default configuration.
ConfigParseException - exception org.wpi.gdc.cms.main.ConfigParseException.
Indicates that an error occured while parsing the configuration file.
ConfigParseException() - Constructor for class org.wpi.gdc.cms.main.ConfigParseException
Creates a new ConfigParseException with no error message.
ConfigParseException(String) - Constructor for class org.wpi.gdc.cms.main.ConfigParseException
Creates a new ConfigParseException with the specified error message.
connect(String, Properties) - Method in class org.wpi.gdc.cms.db.DBEngine
Connects to the database using the given db URL from the configuration options.
connect(String, Properties) - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
ConnectionPool - class org.wpi.gdc.cms.db.jdbc.ConnectionPool.
Manages a pool of database connections.
ConnectionPool(Driver, String, Properties) - Constructor for class org.wpi.gdc.cms.db.jdbc.ConnectionPool
 

D

DatabaseException - exception org.wpi.gdc.cms.db.DatabaseException.
Indicates that an error occured while attempting to load data from a database.
DatabaseException() - Constructor for class org.wpi.gdc.cms.db.DatabaseException
Creates a new DatabaseException with no message and no embedded throwable.
DatabaseException(String) - Constructor for class org.wpi.gdc.cms.db.DatabaseException
Creates a new DatabaseException with the specified message and no embedded throwable.
DatabaseException(String, Throwable) - Constructor for class org.wpi.gdc.cms.db.DatabaseException
Creates a new DatabaseException with the specified message and embedded throwable.
DataSource - class org.wpi.gdc.cms.main.DataSource.
A DataSource takes SAX events and based on them passes new SAX events onto the XMLConsumer object.
DataSource() - Constructor for class org.wpi.gdc.cms.main.DataSource
 
DataSourcePassthrough - class org.wpi.gdc.cms.main.DataSourcePassthrough.
Same as DataSource, except that this method passes all SAX events received onto the consumer.
DataSourcePassthrough() - Constructor for class org.wpi.gdc.cms.main.DataSourcePassthrough
 
dataSources - Variable in class org.wpi.gdc.cms.main.Session
Data sources relating to this session.
dataSources - Variable in class org.wpi.gdc.cms.main.Config
A set of tag names and the corresponding class names.
dbEngine - Variable in class org.wpi.gdc.cms.main.Config
String representation of the database engine.
DBEngine - class org.wpi.gdc.cms.db.DBEngine.
An abstract class that contains the basic interface that allows the CMS to load and save objects into the database.
DBEngine() - Constructor for class org.wpi.gdc.cms.db.DBEngine
 
DBIterator - interface org.wpi.gdc.cms.db.DBIterator.
Almost identical to an Iterator, this contains one method used to signal that even though there are still items left to be retrieved, the caller no longer wishes to receive them.
dbProps - Variable in class org.wpi.gdc.cms.main.Config
Properties for the database.
dbUrl - Variable in class org.wpi.gdc.cms.main.Config
String representation of the database URL.
destroyConnection(Connection) - Method in class org.wpi.gdc.cms.db.jdbc.ConnectionPool
 
done() - Method in interface org.wpi.gdc.cms.db.DBIterator
Indicates that the caller is done with this iterator and no longer requires results from it.

E

endCDATA() - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
endCDATA() - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.
endDataSource() - Method in class org.wpi.gdc.cms.main.DataSource
Signals that this DataSource has just been left.
endDocument() - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
endDocument() - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.
endDTD() - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
endDTD() - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.
endElement(String, String, String) - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
endElement(String, String, String) - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.
endEntity(String) - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
endEntity(String) - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.
endPrefixMapping(String) - Method in class org.wpi.gdc.cms.main.DataSource
This event should never be passed to the consumer via a DataSource, the engine takes care of passing the event.
engine - Variable in class org.wpi.gdc.cms.main.Session
The database engine used to load objects for this session.
enterTag(String, Attribute[]) - Method in interface org.wpi.gdc.xml.LiteXMLCallback
Enter a new tag.
Event - class org.wpi.gdc.cms.main.Event.
An event.
Event(int, String, String, String, String, Hashtable, Vector) - Constructor for class org.wpi.gdc.cms.main.Event
Creates a new Event based on the passed values.
EventItem - class org.wpi.gdc.cms.main.EventItem.
An event item.
EventItem(int, Calendar, Calendar, Hashtable) - Constructor for class org.wpi.gdc.cms.main.EventItem
Creates a new Event based on the passed values.
EXECUTE_FLAG - Static variable in class org.wpi.gdc.cms.main.ACL
The EXECUTE permission for a user's flags.
exitTag(String) - Method in interface org.wpi.gdc.xml.LiteXMLCallback
Exit a tag.

F

field - Variable in class org.wpi.gdc.cms.db.Restriction
The field this applies to - varies based on object.
FIELD_ABSTRACT - Static variable in class org.wpi.gdc.cms.main.NewsStory
The story abstract field.
FIELD_AUTHOR - Static variable in class org.wpi.gdc.cms.main.NewsStory
The story author field.
FIELD_BODY - Static variable in class org.wpi.gdc.cms.main.NewsStory
The story body field.
FIELD_END - Static variable in class org.wpi.gdc.cms.main.EventItem
The event item enddate field.
FIELD_END - Static variable in class org.wpi.gdc.cms.main.Event
The event end field.
FIELD_HEADLINE - Static variable in class org.wpi.gdc.cms.main.NewsStory
The story headline field.
FIELD_ID - Static variable in class org.wpi.gdc.cms.main.EventItem
The event item ID field.
FIELD_ID - Static variable in class org.wpi.gdc.cms.main.Event
The event ID field.
FIELD_ID - Static variable in class org.wpi.gdc.cms.main.NewsStory
The story ID field.
FIELD_LOCATION - Static variable in class org.wpi.gdc.cms.main.Event
The event web URL field.
FIELD_NAME - Static variable in class org.wpi.gdc.cms.main.Event
The event name field.
FIELD_PAIRS - Static variable in class org.wpi.gdc.cms.main.EventItem
The event item name/value pairs field.
FIELD_PAIRS - Static variable in class org.wpi.gdc.cms.main.Event
The event name/value pairs field.
FIELD_POSTED - Static variable in class org.wpi.gdc.cms.main.NewsStory
The story posted field.
FIELD_SHORT_NAME - Static variable in class org.wpi.gdc.cms.main.Event
The event shortName field.
FIELD_START - Static variable in class org.wpi.gdc.cms.main.EventItem
The event item startdate field.
FIELD_START - Static variable in class org.wpi.gdc.cms.main.Event
The event start field.
FIELD_TOPIC - Static variable in class org.wpi.gdc.cms.main.NewsStory
The story topic field.
FIELD_URL - Static variable in class org.wpi.gdc.cms.main.Event
The event web URL field.

G

getAbstract() - Method in class org.wpi.gdc.cms.main.NewsStory
Gets the abstract of the story.
getAlt() - Method in class org.wpi.gdc.cms.main.Icon
Retreives the Alt text for this Icon.
getAuthenticatedUser(String) - Method in class org.wpi.gdc.cms.main.Session
Loads the user associated with the authentication token or returns null if either the user does not exist or the authentication failed.
getAuthor() - Method in class org.wpi.gdc.cms.main.NewsStory
Gets the author of the article.
getBody() - Method in class org.wpi.gdc.cms.main.NewsStory
Gets the full body of the story.
getBoolean() - Method in class org.wpi.gdc.cms.db.Restriction
Retrieves the boolean value for the next restriction in the chain.
getCompareMode() - Method in class org.wpi.gdc.cms.db.StringRestriction
Retrieves the string being checked.
getConnection() - Method in class org.wpi.gdc.cms.db.jdbc.ConnectionPool
 
getDataSource(String) - Method in class org.wpi.gdc.cms.main.Session
Gets the data source associated with the given string, or null if there is no source for the given name.
getDataSource(String) - Method in class org.wpi.gdc.cms.main.Config
Returns the datasource as specified in the configuration files associated with the given ID.
getDataSources() - Method in class org.wpi.gdc.cms.main.Config
 
getDBEngine() - Method in class org.wpi.gdc.cms.main.Session
Retrieves the database engine.
getDBEngine() - Method in class org.wpi.gdc.cms.main.Config
 
getDBProperties() - Method in class org.wpi.gdc.cms.main.Config
 
getDBURL() - Method in class org.wpi.gdc.cms.main.Config
 
getDescription() - Method in class org.wpi.gdc.cms.main.Topic
Retrieves the description of this topic.
getEmbeddedThrowable() - Method in class org.wpi.gdc.cms.db.DatabaseException
Gets the embedded throwable or null if there is none.
getEndDate() - Method in class org.wpi.gdc.cms.main.EventItem
 
getEndDate() - Method in class org.wpi.gdc.cms.main.Event
returns the end date for event (marked by end date for last day of event).
getField() - Method in class org.wpi.gdc.cms.db.Restriction
Retrieves the field.
getFullName() - Method in class org.wpi.gdc.cms.main.User
 
getGroup(int) - Static method in class org.wpi.gdc.cms.main.Group
Loads the
getHeadline() - Method in class org.wpi.gdc.cms.main.NewsStory
Gets the headline of the story.
getIcon() - Method in class org.wpi.gdc.cms.main.Topic
Retrieves the icon for this topic.
getIcon(int) - Method in class org.wpi.gdc.cms.main.Session
Get an icon based on the ID for the Icon.
getID() - Method in class org.wpi.gdc.cms.main.EventItem
 
getID() - Method in class org.wpi.gdc.cms.main.Event
 
getID() - Method in class org.wpi.gdc.cms.main.User
 
getID() - Method in class org.wpi.gdc.cms.main.Topic
Retrieves the ID of this topic.
getID() - Method in class org.wpi.gdc.cms.main.Icon
Retreives the ID of this Icon.
getID() - Method in class org.wpi.gdc.cms.main.NewsStory
Gets the ID of the news story.
getItems() - Method in class org.wpi.gdc.cms.main.Event
 
getLocation() - Method in class org.wpi.gdc.cms.main.Event
 
getLogger() - Method in class org.wpi.gdc.cms.main.Session
 
getName() - Method in class org.wpi.gdc.cms.main.Event
 
getName() - Method in class org.wpi.gdc.cms.main.Topic
Retrieves the name of this topic.
getName() - Method in class org.wpi.gdc.cms.main.Icon
Retreives the name of this Icon.
getNot() - Method in class org.wpi.gdc.cms.db.Restriction
Determines if the logic for this restriction is reveresed or not (if it has a logical NOT applied to it).
getPairs() - Method in class org.wpi.gdc.cms.main.EventItem
 
getPairs() - Method in class org.wpi.gdc.cms.main.Event
 
getPermissions() - Method in class org.wpi.gdc.cms.main.ACLEntry
Gets the permissions associated with this ACL entry.
getPosted() - Method in class org.wpi.gdc.cms.main.NewsStory
Gets the time the story was posted.
getSession(String) - Static method in class org.wpi.gdc.cms.main.Session
Obtains a session based on the session ID.
getShortName() - Method in class org.wpi.gdc.cms.main.Event
 
getStartDate() - Method in class org.wpi.gdc.cms.main.EventItem
 
getStartDate() - Method in class org.wpi.gdc.cms.main.Event
returns the start date for event (marked by start date for first day of event).
getString() - Method in class org.wpi.gdc.cms.db.StringRestriction
Retrieves the string being checked.
getTopic() - Method in class org.wpi.gdc.cms.main.NewsStory
Gets the Topic object for this story.
getTopic(int) - Method in class org.wpi.gdc.cms.main.Session
Get a topic based on the ID for the Topic.
getTopics() - Method in class org.wpi.gdc.cms.main.Session
Retreives all the topic items.
getURL() - Method in class org.wpi.gdc.cms.main.Event
 
getURL() - Method in class org.wpi.gdc.cms.main.Icon
Retreives the URL for this Icon.
getUser(int) - Method in class org.wpi.gdc.cms.main.Session
Gets a user based on the given ID - returns null if the user doesn't exist.
getUser(String) - Method in class org.wpi.gdc.cms.main.Session
Gets a user based on the given username - returns null if the user doesn't exist.
getUserName() - Method in class org.wpi.gdc.cms.main.User
 
Group - class org.wpi.gdc.cms.main.Group.
Represents a Group of users.

H

hashUser(User) - Method in class org.wpi.gdc.cms.main.Session
Creates an athentication token for a User object, used to reobtain the user of subsequent calls.
hasPermission(int) - Method in class org.wpi.gdc.cms.main.ACLEntry
Checks to see if all permissions passed (from the ACL class's permission constants) are present on this ACLEntry.
hasPermission(int) - Method in class org.wpi.gdc.cms.main.ACLUserEntry
Checks to see if all permissions passed (from the ACL class's permission constants) are present on this ACLEntry.
hasSessionID(String) - Method in class org.wpi.gdc.cms.main.Config
Session IDs are not implemented yet; this method is useless! Determines if the given session ID exists in this configuration.

I

Icon - class org.wpi.gdc.cms.main.Icon.
An icon is basically just a URL to an image.
Icon(int, String, String, String) - Constructor for class org.wpi.gdc.cms.main.Icon
Creates an Icon - usually this method is called only by the DBEngine, but it can be used to create new icons as well.
icons - Variable in class org.wpi.gdc.cms.main.Session
Icons from the database (icons are loaded on session creation and are always available).
ignorableWhitespace(char[], int, int) - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
ignorableWhitespace(char[], int, int) - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.
INCLUDE_AFTER_TODAY - Static variable in class org.wpi.gdc.cms.db.DBEngine
Constant for including items after the current date.
INCLUDE_BEFORE_TODAY - Static variable in class org.wpi.gdc.cms.db.DBEngine
Constant for including items before the current date.
isConnected() - Method in class org.wpi.gdc.cms.db.DBEngine
Determines if the database is connected (ie, a call to connect succeeded).
isConnected() - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 

L

LiteXML - class org.wpi.gdc.xml.LiteXML.
A super-light XML parser, this ALMOST follows the XML spec.
LiteXML(LiteXMLCallback) - Constructor for class org.wpi.gdc.xml.LiteXML
Creates a new LiteXML parser object that returns parsed information to the given callback.
LiteXMLCallback - interface org.wpi.gdc.xml.LiteXMLCallback.
Callback for the LiteXML parser.
LiteXMLParseException - exception org.wpi.gdc.xml.LiteXMLParseException.
An error occured while parsing XML.
LiteXMLParseException() - Constructor for class org.wpi.gdc.xml.LiteXMLParseException
Creates a new LiteXMLParseException with no message.
LiteXMLParseException(int, int, String) - Constructor for class org.wpi.gdc.xml.LiteXMLParseException
Creates a new LiteXMLParseException with a line and column number.
LiteXMLParseException(String) - Constructor for class org.wpi.gdc.xml.LiteXMLParseException
Creates a new LiteXMLParseException with an error message.
loadConfiguration(File) - Static method in class org.wpi.gdc.cms.main.Session
 
loadConfiguration(Reader) - Static method in class org.wpi.gdc.cms.main.Config
Loads a configuration file.
loadConfiguration(String) - Static method in class org.wpi.gdc.cms.main.Session
Loads a given configuration file.
loadEvent(int) - Method in class org.wpi.gdc.cms.db.DBEngine
Events are stored in a database via a numeric ID, this method should load the actual data based on the ID.
loadEvent(int) - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
loadEvent(String) - Method in class org.wpi.gdc.cms.db.DBEngine
Each events to be accessed through the website must have a unique name identifier (which will correspond with that event's URL).
loadEvent(String) - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
loadEventCount() - Method in class org.wpi.gdc.cms.db.DBEngine
Counts the number of event groups available.
loadEventCount() - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
loadEvents() - Method in class org.wpi.gdc.cms.db.DBEngine
Gets an DBIterator over the event groups in the database.
loadEvents() - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
loadEvents(int, int) - Method in class org.wpi.gdc.cms.db.DBEngine
Gets a DBIterator over the event groups in the database, ordered by the given order.
loadEvents(int, int) - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
loadEvents(int, int, int) - Method in class org.wpi.gdc.cms.db.DBEngine
Gets a DBIterator over the event groups in the database, ordered by the given order, and limited to the given amount.
loadEvents(int, int, int) - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
loadEventsFromDate(int, int, int) - Method in class org.wpi.gdc.cms.db.DBEngine
Gets a DBIterator over the event groups in the database, either before or after the current day (determined by range), ordered by the given order, and limited to the given amount.
loadEventsFromDate(int, int, int) - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
loadIcons() - Method in class org.wpi.gdc.cms.db.DBEngine
Gets all the Icons in a database.
loadIcons() - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
loadNewsStories() - Method in class org.wpi.gdc.cms.db.DBEngine
Gets an DBIterator over the news stories in the database.
loadNewsStories() - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
Gets an DBIterator over the news stories in the database.
loadNewsStories(int, int) - Method in class org.wpi.gdc.cms.db.DBEngine
Gets a DBIterator over the news stories in the database, ordered by the given order.
loadNewsStories(int, int) - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
loadNewsStories(int, int, int) - Method in class org.wpi.gdc.cms.db.DBEngine
Gets a DBIterator over the news stories in the database, ordered by the given order, and limited to the given amount.
loadNewsStories(int, int, int) - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
loadNewsStory(int) - Method in class org.wpi.gdc.cms.db.DBEngine
News stories are stored in a database via a numeric ID, this method should load the actual data based on the ID.
loadNewsStory(int) - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
loadNewsStoryCount() - Method in class org.wpi.gdc.cms.db.DBEngine
Counts the number of news stories available.
loadNewsStoryCount() - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
loadTopics() - Method in class org.wpi.gdc.cms.db.DBEngine
Gets all the Topics in a database.
loadTopics() - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
loadUser(int) - Method in class org.wpi.gdc.cms.db.DBEngine
Users are stored in a database via a numeric ID, this method should load the actual data based on the ID.
loadUser(int) - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
loadUser(String) - Method in class org.wpi.gdc.cms.db.DBEngine
Load a User from the DB based on the username.
loadUser(String) - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
locator - Variable in class org.wpi.gdc.cms.main.DataSource
The document locator as set via the default setDocumentLocator method.

M

MySQLDBEngine - class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine.
DBEngine for use with a MySQL database backend.
MySQLDBEngine() - Constructor for class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
myUser - Variable in class org.wpi.gdc.cms.main.ACLUserEntry
 

N

name - Variable in class org.wpi.gdc.xml.Attribute
 
NewsStory - class org.wpi.gdc.cms.main.NewsStory.
A news story.
NewsStory(int, User, Topic, Calendar, String, String, String) - Constructor for class org.wpi.gdc.cms.main.NewsStory
Creates a new NewsStory based on the passed values.
next - Variable in class org.wpi.gdc.cms.db.Restriction
The next restriction in the chain or null if there is none.
NoSuchUserException - exception org.wpi.gdc.cms.main.NoSuchUserException.
There was no user belonging to the session.
NoSuchUserException() - Constructor for class org.wpi.gdc.cms.main.NoSuchUserException
Creates a new NoSuchUserException with no error message.
NoSuchUserException(String) - Constructor for class org.wpi.gdc.cms.main.NoSuchUserException
Creates a new NoSuchUserException with the specified error message.

O

ORDER_ASCENDING - Static variable in class org.wpi.gdc.cms.db.DBEngine
Constant for ordering in ascending order.
ORDER_DESCENDING - Static variable in class org.wpi.gdc.cms.db.DBEngine
Constant for ordering in descending order.
org.wpi.gdc.cms.db - package org.wpi.gdc.cms.db
 
org.wpi.gdc.cms.db.jdbc - package org.wpi.gdc.cms.db.jdbc
 
org.wpi.gdc.cms.main - package org.wpi.gdc.cms.main
 
org.wpi.gdc.xml - package org.wpi.gdc.xml
 

P

parse(File) - Method in class org.wpi.gdc.xml.LiteXML
 
parse(InputStream) - Method in class org.wpi.gdc.xml.LiteXML
 
parse(Reader) - Method in class org.wpi.gdc.xml.LiteXML
Preferred parse command (all others call this) - parses an XML document read.
permissions - Variable in class org.wpi.gdc.cms.main.ACLEntry
The permissions this entry grants.
processingInstruction(String, String) - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
processingInstruction(String, String) - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.

R

READ_FLAG - Static variable in class org.wpi.gdc.cms.main.ACL
The READ permission for a user's flags.
receiveText(String) - Method in interface org.wpi.gdc.xml.LiteXMLCallback
Receive the text that is between the current tag and any upcoming tags.
releaseConnection(Connection) - Method in class org.wpi.gdc.cms.db.jdbc.ConnectionPool
 
request - Variable in class org.wpi.gdc.cms.main.DataSource
The HTTP Request which eventually resulted in the usage of this DataSource.
response - Variable in class org.wpi.gdc.cms.main.DataSource
The HTTP Response which uses this DataSource.
Restriction - class org.wpi.gdc.cms.db.Restriction.
Restrictions describe what values are required for certain fields.
Restriction() - Constructor for class org.wpi.gdc.cms.db.Restriction
 

S

saveNewsStory(NewsStory) - Method in class org.wpi.gdc.cms.db.DBEngine
Save a NewsStory into the database.
saveNewsStory(NewsStory) - Method in class org.wpi.gdc.cms.db.jdbc.MySQLDBEngine
 
sendDatabaseException(DatabaseException) - Method in class org.wpi.gdc.cms.main.DataSource
Standard method for creating writing out a DatabaseException that occured while processing a DataSource.
sendException(Throwable) - Method in class org.wpi.gdc.cms.main.DataSource
Standard method for creating writing out an Exception that occured while processing a DataSource.
sendString(String) - Method in class org.wpi.gdc.cms.main.DataSource
Creates a SAX characters corresponding to the given string.
sendString(XMLConsumer, String) - Static method in class org.wpi.gdc.cms.main.DataSource
Creates a SAX characters corresponding to the given string.
session - Variable in class org.wpi.gdc.cms.db.DBEngine
The session object for this engine.
session - Variable in class org.wpi.gdc.cms.main.DataSource
The session associated with the caller for this data source.
Session - class org.wpi.gdc.cms.main.Session.
This class represents the current CMS session.
setAbstract(String) - Method in class org.wpi.gdc.cms.main.NewsStory
Sets the abstract of the story.
setAlt(String) - Method in class org.wpi.gdc.cms.main.Icon
Sets the ALT text for this Icon.
setAuthor(User) - Method in class org.wpi.gdc.cms.main.NewsStory
Sets the author of the article.
setBody(String) - Method in class org.wpi.gdc.cms.main.NewsStory
Sets the full body of the story.
setBoolean(int) - Method in class org.wpi.gdc.cms.db.Restriction
Sets the boolean value for the next restriction in the chain.
setCompareMode(int) - Method in class org.wpi.gdc.cms.db.StringRestriction
Sets the compare mode.
setDescription(String) - Method in class org.wpi.gdc.cms.main.Topic
Sets the description for this topic.
setDocumentLocator(Locator) - Method in class org.wpi.gdc.cms.main.DataSource
Passes the Locator onto this datasource - this should NOT be passed onto the consumer as it already will have been.
setField(String) - Method in class org.wpi.gdc.cms.db.Restriction
Sets the field.
setHeadline(String) - Method in class org.wpi.gdc.cms.main.NewsStory
Sets the headline of the story.
setIcon(Icon) - Method in class org.wpi.gdc.cms.main.Topic
Sets the icon for this topic.
setID(int) - Method in class org.wpi.gdc.cms.main.NewsStory
Sets the story ID.
setLogger(Logger) - Method in class org.wpi.gdc.cms.main.Session
 
setName(String) - Method in class org.wpi.gdc.cms.main.Topic
Sets the name for this topic.
setName(String) - Method in class org.wpi.gdc.cms.main.Icon
Sets the Name of this Icon.
setNot(boolean) - Method in class org.wpi.gdc.cms.db.Restriction
Sets if the logic for this restriction is reveresed or not (if it has a logical NOT applied to it).
setPosted(Calendar) - Method in class org.wpi.gdc.cms.main.NewsStory
Sets the time the story was posted.
setSession(Session) - Method in class org.wpi.gdc.cms.db.DBEngine
Sets the Session object for this DBEngine.
setString(String) - Method in class org.wpi.gdc.cms.db.StringRestriction
Sets the string.
setTopic(Topic) - Method in class org.wpi.gdc.cms.main.NewsStory
Sets the Topic object for this story.
setupDataSource(XMLConsumer, Session, HttpServletRequest, HttpServletResponse, User) - Method in class org.wpi.gdc.cms.main.DataSource
Sets up the DataSource, this is called before any other method via the CMS engine.
setURL(String) - Method in class org.wpi.gdc.cms.main.Icon
Sets the URL for this Icon.
skippedEntity(String) - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
skippedEntity(String) - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.
startCDATA() - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
startCDATA() - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.
startDataSource() - Method in class org.wpi.gdc.cms.main.DataSource
Signals that this DataSource has just been activated.
startDocument() - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
startDocument() - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.
startDTD(String, String, String) - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
startDTD(String, String, String) - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.
startElement(String, String, String, Attributes) - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
startElement(String, String, String, Attributes) - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.
startEntity(String) - Method in class org.wpi.gdc.cms.main.DataSource
A SAX event; this implementation does nothing.
startEntity(String) - Method in class org.wpi.gdc.cms.main.DataSourcePassthrough
A SAX event; this implementation passes the SAX event to the XML Consumer.
startPrefixMapping(String, String) - Method in class org.wpi.gdc.cms.main.DataSource
This event should never be passed to the consumer via a DataSource, the engine takes care of passing the event.
string - Variable in class org.wpi.gdc.cms.db.StringRestriction
The example string.
StringRestriction - class org.wpi.gdc.cms.db.StringRestriction.
This restriction describes how a string should appear.
StringRestriction(String, int) - Constructor for class org.wpi.gdc.cms.db.StringRestriction
Creates a new StringRestriction.

T

Topic - class org.wpi.gdc.cms.main.Topic.
The Topic class represents a Topic for news stories.
Topic(int, String, String, Icon) - Constructor for class org.wpi.gdc.cms.main.Topic
Creates a new Topic object.
topics - Variable in class org.wpi.gdc.cms.main.Session
Topics from the database (topics are loaded on session creation and are always available).
toString() - Method in class org.wpi.gdc.cms.main.EventItem
 
toString() - Method in class org.wpi.gdc.cms.main.Event
 
toString() - Method in class org.wpi.gdc.cms.main.NewsStory
Creates a string that represents the fields in the story.
toString() - Method in class org.wpi.gdc.cms.main.Config
Creates a string that describes this configuration.

U

user - Variable in class org.wpi.gdc.cms.main.DataSource
The User object which is logged in for this request.
User - class org.wpi.gdc.cms.main.User.
This class implements a user account.
User(int, int, String, String, String) - Constructor for class org.wpi.gdc.cms.main.User
Creates a new user.
users - Variable in class org.wpi.gdc.cms.main.Session
Cache of user objects.
users - Variable in class org.wpi.gdc.cms.main.Group
The array of User objects associated with this Group.

V

validate(Object) - Method in class org.wpi.gdc.cms.db.Restriction
Validate this restriction against a sample object.
validate(Object) - Method in class org.wpi.gdc.cms.db.StringRestriction
Validate this restriction against a sample object.
validatePassword(String) - Method in class org.wpi.gdc.cms.main.User
Checks to see if the passed password validates with the password for this user.
validateUser(String, String) - Method in class org.wpi.gdc.cms.main.Session
Validates the username/password pair, returning the user if the username and password are valid.
value - Variable in class org.wpi.gdc.xml.Attribute
 

W

WRITE_FLAG - Static variable in class org.wpi.gdc.cms.main.ACL
The WRITE permission for a user's flags.

X

xmlConsumer - Variable in class org.wpi.gdc.cms.main.DataSource
This is the consumer as set via the standard interface.
xmlParser - Variable in class org.wpi.gdc.cms.main.Config
SAX XML parser.

A B C D E F G H I L M N O P R S T U V W X
WPI GDC CMS 0.0.1

Copyright 2001 WPI Game Development Club. All Rights Reserved.