From 69f0e6b0bf0dc0a6c6fe8ccf17c74960697ca10c Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Sun, 8 Feb 2009 01:37:25 +0000 Subject: 1.0 released --- javadoc/server/CalendarDatabase.html | 439 +++++++++++++++++++++ javadoc/server/CalendarFormatParser.html | 311 +++++++++++++++ javadoc/server/NetCalendarServer.html | 296 ++++++++++++++ javadoc/server/class-use/CalendarDatabase.html | 136 +++++++ javadoc/server/class-use/CalendarFormatParser.html | 136 +++++++ javadoc/server/class-use/NetCalendarServer.html | 136 +++++++ javadoc/server/package-frame.html | 36 ++ javadoc/server/package-summary.html | 156 ++++++++ javadoc/server/package-tree.html | 148 +++++++ javadoc/server/package-use.html | 136 +++++++ 10 files changed, 1930 insertions(+) create mode 100644 javadoc/server/CalendarDatabase.html create mode 100644 javadoc/server/CalendarFormatParser.html create mode 100644 javadoc/server/NetCalendarServer.html create mode 100644 javadoc/server/class-use/CalendarDatabase.html create mode 100644 javadoc/server/class-use/CalendarFormatParser.html create mode 100644 javadoc/server/class-use/NetCalendarServer.html create mode 100644 javadoc/server/package-frame.html create mode 100644 javadoc/server/package-summary.html create mode 100644 javadoc/server/package-tree.html create mode 100644 javadoc/server/package-use.html (limited to 'javadoc/server') diff --git a/javadoc/server/CalendarDatabase.html b/javadoc/server/CalendarDatabase.html new file mode 100644 index 0000000..81605d6 --- /dev/null +++ b/javadoc/server/CalendarDatabase.html @@ -0,0 +1,439 @@ + + + + + + +CalendarDatabase + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +server +
+Class CalendarDatabase

+
+java.lang.Object
+  extended byserver.CalendarDatabase
+
+
+
+
public final class CalendarDatabase
extends java.lang.Object
+ +

+A object of this class encapsulates the whole calendar database on the server side. + This class is used for getting/modifying and adding/removing of calendar events. +

+ +

+

+
Author:
+
buetow
+
+
+ +

+ + + + + + + + + + + + + + + + +
+Constructor Summary
CalendarDatabase(java.util.Vector vecCategories) + +
+          Simple constructur.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddEvent(ClientRequest clientRequest) + +
+          This method adds a calendar event to the calendar database.
+ voiddeleteEvent(ClientRequest clientRequest) + +
+          This method deletes a calendar event of the calendar database.
+ voidflush() + +
+          This method flushes all the changed calendar categories of the calendar database to the filesystem.
+ java.util.VectorgetAllEvents() + +
+          This method returns a Vector of all available calendar events.
+ java.util.VectorgetCategories() + +
+          Gets all calendar categories.
+ CalendarCategorygetCategory(java.lang.String sCategoryName) + +
+          Returns a specific calendar category using fast hash lookup.
+ CalendarEventgetEvent(int iEventID) + +
+          Returns a specific calendar event using fast hash lookup.
+ java.util.VectorgetMatchingEvents(ClientRequest clientRequest) + +
+          This method looks for all calendar events which match the a given client request.
+ voidmodifyEvent(ClientRequest clientRequest) + +
+          This method modifies an calendar event of the calendar database.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+CalendarDatabase

+
+public CalendarDatabase(java.util.Vector vecCategories)
+
+
Simple constructur. Creates a calendar database. +

+

Parameters:
vecCategories - Specifies the vector of CalendarCategory objects for initial database content.
+ + + + + + + + +
+Method Detail
+ +

+getEvent

+
+public CalendarEvent getEvent(int iEventID)
+
+
Returns a specific calendar event using fast hash lookup. +

+

+
Parameters:
iEventID - Specifies the ID of the calendar event to lookup. +
Returns:
Returns the requested calendar event.
+
+
+
+ +

+getCategory

+
+public CalendarCategory getCategory(java.lang.String sCategoryName)
+
+
Returns a specific calendar category using fast hash lookup. +

+

+
Parameters:
sCategoryName - Specifies the name of the calendar category to lookup. +
Returns:
Returns the requested calendar category.
+
+
+
+ +

+getCategories

+
+public java.util.Vector getCategories()
+
+
Gets all calendar categories. +

+

+ +
Returns:
Returns a Vector of all available CalendarCategory objects.
+
+
+
+ +

+getAllEvents

+
+public java.util.Vector getAllEvents()
+
+
This method returns a Vector of all available calendar events. +

+

+ +
Returns:
Returns all available CalendarEvent objects of the database.
+
+
+
+ +

+getMatchingEvents

+
+public java.util.Vector getMatchingEvents(ClientRequest clientRequest)
+
+
This method looks for all calendar events which match the a given client request. +

+

+
Parameters:
clientRequest - Specifies the client request sent by the calendar client. +
Returns:
Returns a Vector of all matching CalendarEvent objects.
+
+
+
+ +

+addEvent

+
+public void addEvent(ClientRequest clientRequest)
+
+
This method adds a calendar event to the calendar database. +

+

+
Parameters:
clientRequest - Specifies the client request sent by the netcalendar client. Its containing the new event to add.
+
+
+
+ +

+modifyEvent

+
+public void modifyEvent(ClientRequest clientRequest)
+
+
This method modifies an calendar event of the calendar database. +

+

+
Parameters:
clientRequest - Specifies the client request sent by the calendar client.
+
+
+
+ +

+deleteEvent

+
+public void deleteEvent(ClientRequest clientRequest)
+
+
This method deletes a calendar event of the calendar database. If the specified calendar event doesnt + exist eny more, nothing will be changed. +

+

+
Parameters:
clientRequest - Specifies the client request sent by the netcalendar client.
+
+
+
+ +

+flush

+
+public void flush()
+
+
This method flushes all the changed calendar categories of the calendar database to the filesystem. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/server/CalendarFormatParser.html b/javadoc/server/CalendarFormatParser.html new file mode 100644 index 0000000..d864051 --- /dev/null +++ b/javadoc/server/CalendarFormatParser.html @@ -0,0 +1,311 @@ + + + + + + +CalendarFormatParser + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +server +
+Class CalendarFormatParser

+
+java.lang.Object
+  extended byserver.CalendarFormatParser
+
+
+
+
public final class CalendarFormatParser
extends java.lang.Object
+ +

+This class is needed for parsing the original UNIX calendar database format. + Its parsing the calendar database from the file-system and its caching it into the + memory. Then, the CalendarDatabase class can be used to access the database. + Each calendar category has its own file. In each file all the calendar events of the + specific categories are stored. +

+ +

+

+
Author:
+
buetow
+
+
+ +

+ + + + + + + + + + + + + + + + +
+Constructor Summary
CalendarFormatParser() + +
+          Simple constructor.
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.util.VectorgetCategories() + +
+          This method returns a vector of all found calendar categories after parsing.
+ voidsetWorkdir(java.lang.String sWorkdir) + +
+          This method sets the working directory.
+ voidstart() + +
+          Starts the parsing work of the calendar database files.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+CalendarFormatParser

+
+public CalendarFormatParser()
+
+
Simple constructor. Creates a calendar format parser object and initializes some private members. +

+

+ + + + + + + + +
+Method Detail
+ +

+getCategories

+
+public java.util.Vector getCategories()
+
+
This method returns a vector of all found calendar categories after parsing. +

+

+ +
Returns:
Returns a Vector of all available CalendarCategory objects.
+
+
+
+ +

+setWorkdir

+
+public void setWorkdir(java.lang.String sWorkdir)
+
+
This method sets the working directory. Its the "server_workdir" variable defined in the current configuration by default. +

+

+
Parameters:
sWorkdir - Specifies the working directory.
+
+
+
+ +

+start

+
+public void start()
+
+
Starts the parsing work of the calendar database files. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/server/NetCalendarServer.html b/javadoc/server/NetCalendarServer.html new file mode 100644 index 0000000..48dd847 --- /dev/null +++ b/javadoc/server/NetCalendarServer.html @@ -0,0 +1,296 @@ + + + + + + +NetCalendarServer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +server +
+Class NetCalendarServer

+
+java.lang.Object
+  extended byjava.lang.Thread
+      extended byserver.NetCalendarServer
+
+
+
All Implemented Interfaces:
java.lang.Runnable
+
+
+
+
public class NetCalendarServer
extends java.lang.Thread
+ +

+This is the main class of the server part of the netcalendar suite. + It contains the server socket part and hold a references to the calendar database. +

+ +

+

+
Author:
+
buetow
+
+
+ +

+ + + + + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
+  + + + + + + + + + + +
+Constructor Summary
NetCalendarServer(int iPort, + java.lang.String sWorkdir) + +
+          Creates a NetCalendarServer instance and runs it as a thread.
+  + + + + + + + + + + + +
+Method Summary
+ voidrun() + +
+          This method specifies the start method of the Thread.
+  + + + + + + + +
Methods inherited from class java.lang.Thread
activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getContextClassLoader, getName, getPriority, getThreadGroup, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setName, setPriority, sleep, sleep, start, stop, stop, suspend, toString, yield
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+NetCalendarServer

+
+public NetCalendarServer(int iPort,
+                         java.lang.String sWorkdir)
+
+
Creates a NetCalendarServer instance and runs it as a thread. +

+

Parameters:
iPort - Specifies the server port of the server to be used.
sWorkdir - Specifies the working directory of the server.
+ + + + + + + + +
+Method Detail
+ +

+run

+
+public void run()
+
+
This method specifies the start method of the Thread. Its setting up the server port. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/javadoc/server/class-use/CalendarDatabase.html b/javadoc/server/class-use/CalendarDatabase.html new file mode 100644 index 0000000..da1626e --- /dev/null +++ b/javadoc/server/class-use/CalendarDatabase.html @@ -0,0 +1,136 @@ + + + + + + +Uses of Class server.CalendarDatabase + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+
+

+Uses of Class
server.CalendarDatabase

+
+No usage of server.CalendarDatabase +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/javadoc/server/class-use/CalendarFormatParser.html b/javadoc/server/class-use/CalendarFormatParser.html new file mode 100644 index 0000000..2555abe --- /dev/null +++ b/javadoc/server/class-use/CalendarFormatParser.html @@ -0,0 +1,136 @@ + + + + + + +Uses of Class server.CalendarFormatParser + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+
+

+Uses of Class
server.CalendarFormatParser

+
+No usage of server.CalendarFormatParser +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/javadoc/server/class-use/NetCalendarServer.html b/javadoc/server/class-use/NetCalendarServer.html new file mode 100644 index 0000000..afd8b79 --- /dev/null +++ b/javadoc/server/class-use/NetCalendarServer.html @@ -0,0 +1,136 @@ + + + + + + +Uses of Class server.NetCalendarServer + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+
+

+Uses of Class
server.NetCalendarServer

+
+No usage of server.NetCalendarServer +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + +
+ + + +
+ + + diff --git a/javadoc/server/package-frame.html b/javadoc/server/package-frame.html new file mode 100644 index 0000000..6a0d3ec --- /dev/null +++ b/javadoc/server/package-frame.html @@ -0,0 +1,36 @@ + + + + + + +server + + + + + + + + + + + +server + + + + +
+Classes  + +
+CalendarDatabase +
+CalendarFormatParser +
+NetCalendarServer
+ + + + diff --git a/javadoc/server/package-summary.html b/javadoc/server/package-summary.html new file mode 100644 index 0000000..2da7ef7 --- /dev/null +++ b/javadoc/server/package-summary.html @@ -0,0 +1,156 @@ + + + + + + +server + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +