Menu
▾
▴
[Babeldoc-devel] babeldoc/modules/core/src/com/babeldoc/core/journal/query JournalQuery.java,1.4,1.5 JournalQueryException.java,1.3,1.4 JournalQueryTest.java,1.4,1.5 QueryOption.java,1.3,1.4 QueryTicket.java,1.5,1.6
Update of /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/query In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7955/modules/core/src/com/babeldoc/core/journal/query Modified Files: JournalQuery.java JournalQueryException.java JournalQueryTest.java QueryOption.java QueryTicket.java Log Message: javadoc and formatting here. Index: JournalQuery.java =================================================================== RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/query/JournalQuery.java,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** JournalQuery.java 27 Jun 2003 02:19:58 -0000 1.4 --- JournalQuery.java 30 Jul 2004 01:33:00 -0000 1.5 *************** *** 91,95 **** /** ! * Null constructor */ public JournalQuery() { --- 91,95 ---- /** ! * Null constructor. */ public JournalQuery() { *************** *** 101,105 **** /** ! * Full constructor * * @param startIndex the start index of the result set --- 101,105 ---- /** ! * Full constructor. * * @param startIndex the start index of the result set *************** *** 125,129 **** * for the date. A Year 2037 problem here. * ! * @param endDate */ public void setEndDate(Date endDate) { --- 125,129 ---- * for the date. A Year 2037 problem here. * ! * @param endDate end date. */ public void setEndDate(Date endDate) { *************** *** 136,142 **** /** ! * get end date * ! * @return */ public Date getEndDate() { --- 136,142 ---- /** ! * get end date. * ! * @return end date */ public Date getEndDate() { *************** *** 145,151 **** /** ! * set the the journal operations * ! * @param journalOperations */ public void setJournalOperations(JournalOperation[] journalOperations) { --- 145,151 ---- /** ! * set the the journal operations. * ! * @param journalOperations array of journal operations. */ public void setJournalOperations(JournalOperation[] journalOperations) { *************** *** 156,160 **** * Get the journal operations. * ! * @return */ public JournalOperation[] getJournalOperations() { --- 156,160 ---- * Get the journal operations. * ! * @return journal operations. */ public JournalOperation[] getJournalOperations() { *************** *** 163,169 **** /** ! * set the number of rows to return * ! * @param numResults */ public void setNumResults(int numResults) { --- 163,169 ---- /** ! * set the number of rows to return. * ! * @param numResults only this number of results. */ public void setNumResults(int numResults) { *************** *** 172,178 **** /** ! * Get the number of rows to return * ! * @return */ public int getNumResults() { --- 172,178 ---- /** ! * Get the number of rows to return. * ! * @return the number of results to show. */ public int getNumResults() { *************** *** 181,187 **** /** ! * Set the query options * ! * @param queryOptions */ public void setQueryOptions(QueryOption[] queryOptions) { --- 181,187 ---- /** ! * Set the query options. * ! * @param queryOptions these query optins. */ public void setQueryOptions(QueryOption[] queryOptions) { *************** *** 190,196 **** /** ! * Get the query options * ! * @return */ public QueryOption[] getQueryOptions() { --- 190,196 ---- /** ! * Get the query options. * ! * @return array of query options. */ public QueryOption[] getQueryOptions() { *************** *** 200,206 **** /** * Set the start date. If a null is passed, the start date is set to the min ! * value for the date * ! * @param startDate */ public void setStartDate(Date startDate) { --- 200,206 ---- /** * Set the start date. If a null is passed, the start date is set to the min ! * value for the date. * ! * @param startDate only from this date */ public void setStartDate(Date startDate) { *************** *** 213,219 **** /** ! * get start date * ! * @return */ public Date getStartDate() { --- 213,219 ---- /** ! * get start date. * ! * @return start date */ public Date getStartDate() { *************** *** 222,228 **** /** ! * set the index * ! * @param startIndex */ public void setStartIndex(int startIndex) { --- 222,228 ---- /** ! * set the index. * ! * @param startIndex start from this index. */ public void setStartIndex(int startIndex) { *************** *** 231,237 **** /** ! * get the start index * ! * @return DOCUMENT ME! */ public int getStartIndex() { --- 231,237 ---- /** ! * get the start index. * ! * @return get the start index. */ public int getStartIndex() { *************** *** 240,248 **** /** ! * private int startIndex; private int numResults; private Date startDate; ! * private Date endDate; private QueryOption[] queryOptions; private ! * JournalOperation[] journalOperations; * ! * @return DOCUMENT ME! */ public String toString() { --- 240,246 ---- /** ! * string representation of the JournalQuery. * ! * @return stringified representation.! */ public String toString() { *************** *** 258,275 **** /** ! * JournalQueryComp: Class to encapsulate a query comparison ! * ! * <p> ! * Title: babel ! * </p> ! * ! * <p> ! * Description: universal document processor the more complicated stuff like ! * reading and writing the deltas are left to the children ! * </p> ! * ! * <p> ! * Copyright: Copyright (c) 2002 ! * </p> * * @author bmcdonald --- 256,260 ---- /** ! * JournalQueryComp: Class to encapsulate a query comparison. * * @author bmcdonald *************** *** 284,292 **** public static JournalQueryComp ne = new JournalQueryComp(5); ! /** Operation - flag */ private int operation; /** ! * Private constructor * * @param operation the operation flag --- 269,277 ---- public static JournalQueryComp ne = new JournalQueryComp(5); ! /** Operation - flag. */ private int operation; /** ! * Private constructor. * * @param operation the operation flag *************** *** 297,303 **** /** ! * equals * ! * @param jquery * * @return true if the operations are equal, else false. --- 282,288 ---- /** ! * equals. * ! * @param jquery is equals. * * @return true if the operations are equal, else false. *************** *** 308,312 **** /** ! * Resolve a string operator into an instance of JournalQueryComp * * @param query the string of the query --- 293,297 ---- /** ! * Resolve a string operator into an instance of JournalQueryComp. * * @param query the string of the query Index: JournalQueryException.java =================================================================== RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/query/JournalQueryException.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** JournalQueryException.java 27 Jun 2003 02:19:58 -0000 1.3 --- JournalQueryException.java 30 Jul 2004 01:33:00 -0000 1.4 *************** *** 78,85 **** public class JournalQueryException extends JournalException { /** ! * Constructor * ! * @param e DOCUMENT ME! ! * @param message DOCUMENT ME! */ public JournalQueryException(Exception e, String message) { --- 78,85 ---- public class JournalQueryException extends JournalException { /** ! * Constructor. * ! * @param e parent exception ! * @param message message */ public JournalQueryException(Exception e, String message) { Index: QueryOption.java =================================================================== RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/query/QueryOption.java,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** QueryOption.java 27 Jun 2003 02:19:58 -0000 1.3 --- QueryOption.java 30 Jul 2004 01:33:00 -0000 1.4 *************** *** 77,94 **** */ public class QueryOption implements Serializable { public static final QueryOption oldestFirst = new QueryOption(0); public static final QueryOption newestFirst = new QueryOption(1); ! /** string representations */ public static final String OLDEST_FIRST = "oldestFirst"; public static final String NEWEST_FIRST = "newestFirst"; ! /** instance variable - just a marker */ private int option; /** ! * Private constructor * ! * @param operation */ private QueryOption(int operation) { --- 77,97 ---- */ public class QueryOption implements Serializable { + /** instantiated object. */ public static final QueryOption oldestFirst = new QueryOption(0); + /** instantiated object. */ public static final QueryOption newestFirst = new QueryOption(1); ! /** string representations. */ public static final String OLDEST_FIRST = "oldestFirst"; + /** string representations. */ public static final String NEWEST_FIRST = "newestFirst"; ! /** instance variable - just a marker. */ private int option; /** ! * Private constructor. * ! * @param operation operation identifier */ private QueryOption(int operation) { *************** *** 97,105 **** /** ! * Convert a string to a query option ! * ! * @param qopt * ! * @return */ public static QueryOption getQueryOption(String qopt) { --- 100,107 ---- /** ! * Convert a string to a query option. * ! * @param qopt identifier to find. ! * @return query option. */ public static QueryOption getQueryOption(String qopt) { *************** *** 114,122 **** /** ! * equality operator - important ! * ! * @param o DOCUMENT ME! * ! * @return DOCUMENT ME! */ public boolean equals(Object o) { --- 116,123 ---- /** ! * equality operator - important. * ! * @param o comparison object ! * @return equality flag */ public boolean equals(Object o) { *************** *** 125,131 **** /** ! * THIS WILL BE CHANGING * ! * @return */ public String toString() { --- 126,132 ---- /** ! * stringified representation. * ! * @return stringified representation. */ public String toString() { Index: JournalQueryTest.java =================================================================== RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/query/JournalQueryTest.java,v retrieving revision 1.4 retrieving revision 1.5 diff -C2 -d -r1.4 -r1.5 *** JournalQueryTest.java 16 Sep 2003 05:19:00 -0000 1.4 --- JournalQueryTest.java 30 Jul 2004 01:33:00 -0000 1.5 *************** *** 69,72 **** --- 69,73 ---- import com.babeldoc.core.journal.JournalFactory; import com.babeldoc.core.journal.JournalOperation; + import com.babeldoc.core.EnvironmentLoader; import junit.framework.Test; *************** *** 82,86 **** */ public class JournalQueryTest extends TestCase { - /** Stuff */ //EjbReferenceManager mgr; --- 83,86 ---- *************** *** 90,96 **** * Creates a new JournalQueryTest object. * ! * @param testName DOCUMENT ME! */ ! public JournalQueryTest(java.lang.String testName) { super(testName); } --- 90,96 ---- * Creates a new JournalQueryTest object. * ! * @param testName junit name */ ! public JournalQueryTest(String testName) { super(testName); } *************** *** 99,111 **** * Run all the test methods in this class. * ! * @param args DOCUMENT ME! */ public static void main(String[] args) { ! com.babeldoc.core.EnvironmentLoader.loadEnvironment(); junit.textui.TestRunner.run(suite()); } /** ! * @return make a test suite */ public static Test suite() { --- 99,112 ---- * Run all the test methods in this class. * ! * @param args command line arguments */ public static void main(String[] args) { ! EnvironmentLoader.loadEnvironment(); junit.textui.TestRunner.run(suite()); } /** ! * . ! * @return make a test suite. */ public static Test suite() { *************** *** 116,119 **** --- 117,121 ---- /** + * get all tickets. * @throws Exception */ *************** *** 136,140 **** /** ! * @throws Exception DOCUMENT ME! */ public void testGetForkedTickets() throws Exception { --- 138,143 ---- /** ! * get forked tickets. ! * @throws Exception */ public void testGetForkedTickets() throws Exception { *************** *** 145,149 **** /** ! * Test getting new tickets * * @throws Exception --- 148,152 ---- /** ! * Test getting new tickets. * * @throws Exception *************** *** 160,166 **** /** ! * Get new tickets newest first * ! * @throws Exception DOCUMENT ME! */ public void testGetNewTicketsNewestFirst() throws Exception { --- 163,169 ---- /** ! * Get new tickets newest first. * ! * @throws Exception */ public void testGetNewTicketsNewestFirst() throws Exception { *************** *** 177,183 **** /** ! * Get new tickets oldest first * ! * @throws Exception DOCUMENT ME! */ public void testGetNewTicketsOldestFirst() throws Exception { --- 180,186 ---- /** ! * Get new tickets oldest first. * ! * @throws Exception */ public void testGetNewTicketsOldestFirst() throws Exception { *************** *** 193,199 **** /** ! * Get the updated documents * ! * @throws Exception DOCUMENT ME! */ public void testGetUpdateDocumentTickets() throws Exception { --- 196,202 ---- /** ! * Get the updated documents. * ! * @throws Exception */ public void testGetUpdateDocumentTickets() throws Exception { *************** *** 204,210 **** /** ! * Get update status tickets * ! * @throws Exception DOCUMENT ME! */ public void testGetUpdateStatusTickets() throws Exception { --- 207,213 ---- /** ! * Get update status tickets. * ! * @throws Exception */ public void testGetUpdateStatusTickets() throws Exception { *************** *** 215,221 **** /** ! * Setup the journal * ! * @throws Exception DOCUMENT ME! */ protected void setUp() throws Exception { --- 218,224 ---- /** ! * Setup the journal. * ! * @throws Exception */ protected void setUp() throws Exception { *************** *** 225,231 **** /** ! * teardown the journal * ! * @throws Exception DOCUMENT ME! */ protected void tearDown() throws Exception { --- 228,234 ---- /** ! * teardown the journal. * ! * @throws Exception */ protected void tearDown() throws Exception { Index: QueryTicket.java =================================================================== RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/query/QueryTicket.java,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** QueryTicket.java 18 Aug 2003 19:21:07 -0000 1.5 --- QueryTicket.java 30 Jul 2004 01:33:00 -0000 1.6 *************** *** 116,124 **** * @param ticket the ticket to use * @param date the date associated with this ticket ! * @param operation * @param stage the pipeline stage name ! * @param other ! * @param step ! * @param additional */ public QueryTicket(IJournalTicket ticket, Date date, String operation, --- 116,124 ---- * @param ticket the ticket to use * @param date the date associated with this ticket ! * @param operation opeation name * @param stage the pipeline stage name ! * @param other other information ! * @param step step number ! * @param additional additional information. */ public QueryTicket(IJournalTicket ticket, Date date, String operation, *************** *** 135,139 **** * Get the additional information at this query step. * ! * @return */ public String getAdditional() { --- 135,139 ---- * Get the additional information at this query step. * ! * @return additional informaton */ public String getAdditional() { *************** *** 142,146 **** /** ! * Get the date of this ticket * * @return date --- 142,146 ---- /** ! * Get the date of this ticket. * * @return date *************** *** 151,155 **** /** ! * Get the operation of this ticket * * @return operation --- 151,155 ---- /** ! * Get the operation of this ticket. * * @return operation *************** *** 160,164 **** /** ! * Get the other data for the ticket (could be parent ticket, etc, etc) * * @return other --- 160,164 ---- /** ! * Get the other data for the ticket (could be parent ticket, etc, etc). * * @return other *************** *** 169,173 **** /** ! * Get the pipeline stage of this ticket * * @return stage --- 169,173 ---- /** ! * Get the pipeline stage of this ticket. * * @return stage *************** *** 178,182 **** /** ! * Get the step for the ticket * * @return other --- 178,182 ---- /** ! * Get the step for the ticket. * * @return other *************** *** 187,191 **** /** ! * Get the ticket * * @return ticket --- 187,191 ---- /** ! * Get the ticket. * * @return ticket *************** *** 196,200 **** /** ! * ToString * * @return string --- 196,200 ---- /** ! * ToString. * * @return string |
