[Babeldoc-devel] babeldoc/modules/core/src/com/babeldoc/core/journal IJournal.java,1.8,1.9 IJournalS

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7955/modules/core/src/com/babeldoc/core/journal

Modified Files:
	IJournal.java IJournalStatus.java IJournalTicket.java 
	Journal.java JournalConfigInfo.java JournalException.java 
	JournalFactory.java JournalOperation.java JournalStatus.java 
	JournalTest.java JournalTicket.java JournalType.java 
Log Message:
javadoc and formatting here.

Index: IJournal.java
===================================================================
RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/IJournal.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** IJournal.java	3 Sep 2003 03:25:30 -0000	1.8
--- IJournal.java	30 Jul 2004 01:33:00 -0000	1.9
***************
*** 73,77 ****

  /**
!  * Interface for the tracking subsystem.  This is meant to provide a means to
   * track a document through the system as well as reprocessing opportunities.
   *
--- 73,77 ----

  /**
!  * Interface for the journalling subsystem.  This is meant to provide a means to
   * track a document through the system as well as reprocessing opportunities.
   *
***************
*** 81,90 ****
  public interface IJournal
      extends IConfigurable {
    /**
!    * getChildrenTickets.  Get all the tickets which are children of this ticket
!    *
!    * @param parent
     *
     * @return array of child tickets.
     */
    public IJournalTicket[] getAllChildTickets(IJournalTicket parent)
--- 81,91 ----
  public interface IJournal
      extends IConfigurable {
+ 
    /**
!    * getChildrenTickets.  Get all the tickets which are children of this ticket.
     *
+    * @param parent journal ticket to find all the children.
     * @return array of child tickets.
+    * @throws JournalException exception
     */
    public IJournalTicket[] getAllChildTickets(IJournalTicket parent)
***************
*** 94,100 ****
     * getJournalForTicket.  Get all the ticketsteps for the ticket.
     *
!    * @param ticket number
!    *
     * @return array of querytickets
     */
    public QueryTicket[] getAllTicketSteps(IJournalTicket ticket)
--- 95,101 ----
     * getJournalForTicket.  Get all the ticketsteps for the ticket.
     *
!    * @param ticket number to query
     * @return array of querytickets
+    * @throws JournalException exception
     */
    public QueryTicket[] getAllTicketSteps(IJournalTicket ticket)
***************
*** 106,112 ****
     * @param ticket - the ticket to replay
     * @param step - the step to replay from
!    *
!    * @return
!    *
     * @throws com.babeldoc.core.journal.JournalException
     */
--- 107,111 ----
     * @param ticket - the ticket to replay
     * @param step - the step to replay from
!    * @return pipeline document at the ticket and step.
     * @throws com.babeldoc.core.journal.JournalException
     */
***************
*** 117,123 ****
     * Get an existing ticket from the string identifier.
     *
!    * @param identifier ;
!    *
     * @return the created tracker ticket
     */
    public IJournalTicket getTicket(String identifier) throws JournalException;
--- 116,122 ----
     * Get an existing ticket from the string identifier.
     *
!    * @param identifier the identifier to use to search for the ticket
     * @return the created tracker ticket
+    * @throws JournalException exception
     */
    public IJournalTicket getTicket(String identifier) throws JournalException;
***************
*** 128,133 ****
     *
     * @param jQuery journal query object
-    *
     * @return the results.
     */
    public QueryTicket[] getTickets(JournalQuery jQuery)
--- 127,132 ----
     *
     * @param jQuery journal query object
     * @return the results.
+    * @throws JournalException exception
     */
    public QueryTicket[] getTickets(JournalQuery jQuery)
***************
*** 138,141 ****
--- 137,141 ----
     *
     * @return the created tracker ticket
+    * @throws JournalException exception
     */
    public IJournalTicket dummyTicket() throws JournalException;
***************
*** 145,150 ****
     *
     * @param parentTicket the creating ticket
-    *
     * @return the created tracker ticket
     */
    public IJournalTicket forkTicket(IJournalTicket parentTicket)
--- 145,150 ----
     *
     * @param parentTicket the creating ticket
     * @return the created tracker ticket
+    * @throws JournalException exception
     */
    public IJournalTicket forkTicket(IJournalTicket parentTicket)
***************
*** 155,163 ****
     *
     * @return the created tracker ticket
     */
    public IJournalTicket newTicket() throws JournalException;

    /**
!    * Log a message into the log file
     *
     * @param ticket track the document
--- 155,164 ----
     *
     * @return the created tracker ticket
+    * @throws JournalException exception
     */
    public IJournalTicket newTicket() throws JournalException;

    /**
!    * Log a message into the log file.
     *
     * @param ticket track the document
***************
*** 170,177 ****

    /**
!    * Replay this ticket from the step
     *
     * @param ticket - the ticket to replay
     * @param step - the step to replay from
     */
    public void replayTicket(IJournalTicket ticket, int step)
--- 171,179 ----

    /**
!    * Replay this ticket from the step.
     *
     * @param ticket - the ticket to replay
     * @param step - the step to replay from
+    * @throws JournalException exception
     */
    public void replayTicket(IJournalTicket ticket, int step)
***************
*** 179,187 ****

    /**
!    * Update a document associated with this ticket
     *
     * @param ticket - the ticket to replay
     * @param document the document to update
     * @param stage the pipeline stage resulting in this status change
     */
    public void updateDocument(IJournalTicket ticket, PipelineDocument document,
--- 181,190 ----

    /**
!    * Update a document associated with this ticket.
     *
     * @param ticket - the ticket to replay
     * @param document the document to update
     * @param stage the pipeline stage resulting in this status change
+    * @throws JournalException exception
     */
    public void updateDocument(IJournalTicket ticket, PipelineDocument document,
***************
*** 189,197 ****

    /**
!    * Update the status of this ticket
     *
     * @param ticket - the ticket for this status
     * @param status - the status of the ticket
     * @param stage the pipeline stage resulting in this status change
     */
    public void updateStatus(IJournalTicket ticket, IJournalStatus status,
--- 192,201 ----

    /**
!    * Update the status of this ticket.
     *
     * @param ticket - the ticket for this status
     * @param status - the status of the ticket
     * @param stage the pipeline stage resulting in this status change
+    * @throws JournalException exception
     */
    public void updateStatus(IJournalTicket ticket, IJournalStatus status,

Index: IJournalTicket.java
===================================================================
RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/IJournalTicket.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** IJournalTicket.java	27 Jun 2003 02:19:57 -0000	1.3
--- IJournalTicket.java	30 Jul 2004 01:33:00 -0000	1.4
***************
*** 84,102 ****
     * journal but not actually do anything.
     *
!    * @return
     */
    public boolean isDummy();

    /**
!    * Get the identifier
     *
!    * @return
     */
    public String getId();

    /**
!    * Basic equality operator for identifier
     *
!    * @return DOCUMENT ME!
     */
    public boolean equals(String ticketId);
--- 84,103 ----
     * journal but not actually do anything.
     *
!    * @return is this a dummy ticket?
     */
    public boolean isDummy();

    /**
!    * Get the identifier.
     *
!    * @return identifier
     */
    public String getId();

    /**
!    * Basic equality operator for identifier.
     *
!    * @param ticketId ticket to compare.
!    * @return equality operator.
     */
    public boolean equals(String ticketId);

Index: JournalConfigInfo.java
===================================================================
RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/JournalConfigInfo.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** JournalConfigInfo.java	3 Sep 2003 03:25:30 -0000	1.1
--- JournalConfigInfo.java	30 Jul 2004 01:33:00 -0000	1.2
***************
*** 8,12 ****

  /**
!  * Journal configuration information class
   *
   * @author bmcdonald
--- 8,13 ----

  /**
!  * Journal configuration information class.  This is the base clss
!  * for journal implementations to represent configuuration infos.
   *
   * @author bmcdonald
***************
*** 16,27 ****
      extends ConfigInfo {

!   /** Service type for pipeline stages */
    public static final ServiceTypeConfigOptionType JOURNAL_TYPE =
        new ServiceTypeConfigOptionType(JournalType.SERVICE_PREFIX);

    /**
!    * This method returns options that are general to all components
     *
!    * @return comments
     */
    public Collection getGeneralOptions() {
--- 17,28 ----
      extends ConfigInfo {

!   /** Service type for pipeline stages. */
    public static final ServiceTypeConfigOptionType JOURNAL_TYPE =
        new ServiceTypeConfigOptionType(JournalType.SERVICE_PREFIX);

    /**
!    * This method returns options that are general to all components.
     *
!    * @return collection of general optins.
     */
    public Collection getGeneralOptions() {
***************
*** 30,34 ****

    /**
!    * Return an xmlized version of the of the config info
     *
     * @return String of configuration information.
--- 31,35 ----

    /**
!    * Return an xmlized version of the of the config info.
     *
     * @return String of configuration information.

Index: JournalType.java
===================================================================
RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/JournalType.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** JournalType.java	23 Jul 2004 22:31:54 -0000	1.6
--- JournalType.java	30 Jul 2004 01:33:00 -0000	1.7
***************
*** 70,74 ****

  /**
!  * Characterize the type of journal.  This type maps to a name and a class to
   * actually provide a concrete implementation.
   *
--- 70,74 ----

  /**
!  * Represent the type of the journal.  This type maps to a name and a class to
   * actually provide a concrete implementation.
   *
***************
*** 90,97 ****

    /**
!    * Get the class of the factory that implements the named factory type
     *
     * @param journalType journal name!
-    *
     * @return class of the user factory
     */
--- 90,96 ----

    /**
!    * Get the class of the factory that implements the named factory type.
     *
     * @param journalType journal name!
     * @return class of the user factory
     */
***************
*** 101,105 ****

    /**
!    * @return service prefix for this type
     */
    public String getServicePrefix() {
--- 100,105 ----

    /**
!    * Get service prefix.
!    * @return service prefix for this type.
     */
    public String getServicePrefix() {

Index: JournalException.java
===================================================================
RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/JournalException.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** JournalException.java	27 Jun 2003 02:19:57 -0000	1.3
--- JournalException.java	30 Jul 2004 01:33:00 -0000	1.4
***************
*** 66,69 ****
--- 66,71 ----
  package com.babeldoc.core.journal;

+ import com.babeldoc.core.GeneralException;
+ 
  /**
   * JournalException is a simple extension of the GeneralException as a marker
***************
*** 73,82 ****
   * @version 1.0
   */
! public class JournalException extends com.babeldoc.core.GeneralException {
    /**
!    * Constructor
     *
!    * @param message DOCUMENT ME!
!    * @param e DOCUMENT ME!
     */
    public JournalException(String message, Throwable e) {
--- 75,84 ----
   * @version 1.0
   */
! public class JournalException extends GeneralException {
    /**
!    * Constructor.
     *
!    * @param message exception message/
!    * @param e parent exception
     */
    public JournalException(String message, Throwable e) {
***************
*** 85,91 ****

    /**
!    * Constructor
     *
!    * @param message DOCUMENT ME!
     */
    public JournalException(String message) {
--- 87,93 ----

    /**
!    * Constructor.
     *
!    * @param message exception message
     */
    public JournalException(String message) {
***************
*** 94,98 ****

    /**
!    * Constructor
     */
    public JournalException() {
--- 96,100 ----

    /**
!    * Constructor.
     */
    public JournalException() {

Index: Journal.java
===================================================================
RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/Journal.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** Journal.java	23 Jul 2004 22:31:54 -0000	1.9
--- Journal.java	30 Jul 2004 01:33:00 -0000	1.10
***************
*** 83,87 ****
  public abstract class Journal implements IJournal {
    /**
!    * Default constructor
     */
    public Journal() {
--- 83,87 ----
  public abstract class Journal implements IJournal {
    /**
!    * Default constructor.
     */
    public Journal() {
***************
*** 89,98 ****

    /**
!    * Replay this ticket from the step
     *
     * @param ticket - the ticket to replay
     * @param step - the step to replay from
!    *
!    * @throws JournalException DOCUMENT ME!
     */
    public synchronized void replayTicket(IJournalTicket ticket, int step)
--- 89,97 ----

    /**
!    * Replay this ticket from the step.
     *
     * @param ticket - the ticket to replay
     * @param step - the step to replay from
!    * @throws JournalException journal exception
     */
    public synchronized void replayTicket(IJournalTicket ticket, int step)
***************
*** 127,132 ****
     * @param document the document to update
     * @param stage the pipeline stage resulting in this status change
!    *
!    * @throws JournalException DOCUMENT ME!
     */
    public void updateDocument(IJournalTicket ticket,
--- 126,130 ----
     * @param document the document to update
     * @param stage the pipeline stage resulting in this status change
!    * @throws JournalException
     */
    public void updateDocument(IJournalTicket ticket,
***************
*** 146,151 ****
     * @param status - the status of the ticket
     * @param stage the pipeline stage resulting in this status change
!    *
!    * @throws JournalException DOCUMENT ME!
     */
    public void updateStatus(IJournalTicket ticket, IJournalStatus status,
--- 144,148 ----
     * @param status - the status of the ticket
     * @param stage the pipeline stage resulting in this status change
!    * @throws JournalException
     */
    public void updateStatus(IJournalTicket ticket, IJournalStatus status,
***************
*** 160,164 ****

    /**
!    * Log a message into the log file
     *
     * @param ticket track the document
--- 157,161 ----

    /**
!    * Log a message into the log file.
     *
     * @param ticket track the document
***************
*** 190,198 ****

    /**
!    * replayJournalStep  replay journal step
     *
     * @param queryTicket replay from here
     *
!    * @throws JournalException DOCUMENT ME!
     */
    protected void replayTicketStep(QueryTicket queryTicket)
--- 187,195 ----

    /**
!    * replayJournalStep  replay journal step .
     *
     * @param queryTicket replay from here
     *
!    * @throws JournalException exception!
     */
    protected void replayTicketStep(QueryTicket queryTicket)

Index: JournalStatus.java
===================================================================
RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/JournalStatus.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** JournalStatus.java	23 Jul 2004 22:31:54 -0000	1.4
--- JournalStatus.java	30 Jul 2004 01:33:00 -0000	1.5
***************
*** 67,74 ****

  /**
!  * <strong>JournalStatus</strong> represents a journal status document.
!  * 
!  * <p>Description: universal document processor the more complicated stuff like
!  * reading and writing the deltas are left to the children</p>
   * 
   * @author bmcdonald
--- 67,71 ----

  /**
!  * <strong>JournalStatus</strong> represents the status that a journal entry can take.
   * 
   * @author bmcdonald
***************
*** 76,89 ****
   */
  public class JournalStatus implements IJournalStatus {
!   /** Constants */
    public static final JournalStatus SUCCESS = new JournalStatus("success");
    public static final JournalStatus FAIL = new JournalStatus("fail");
    public static final JournalStatus COMPLETED = new JournalStatus("completed");
    public static final JournalStatus IGNORED = new JournalStatus("ignored");

!   /** the additional info */
    private String additionalInfo;

!   /** The status string */
    private String status;

--- 73,89 ----
   */
  public class JournalStatus implements IJournalStatus {
!   /** Instance of status. */
    public static final JournalStatus SUCCESS = new JournalStatus("success");
+   /** Instance of status. */
    public static final JournalStatus FAIL = new JournalStatus("fail");
+   /** Instance of status. */
    public static final JournalStatus COMPLETED = new JournalStatus("completed");
+   /** Instance of status. */
    public static final JournalStatus IGNORED = new JournalStatus("ignored");

!   /** the additional info. */
    private String additionalInfo;

!   /** The status string. */
    private String status;

***************
*** 99,103 ****

    /**
!    * Set the additional information for this status
     *
     * @param additionalInfo extra information on this status
--- 99,103 ----

    /**
!    * Set the additional information for this status.
     *
     * @param additionalInfo extra information on this status
***************
*** 108,112 ****

    /**
!    * Get the additional information for this status
     *
     * @return addition information
--- 108,112 ----

    /**
!    * Get the additional information for this status.
     *
     * @return addition information
***************
*** 121,125 ****

    /**
!    * toString
     *
     * @return stringified object
--- 121,125 ----

    /**
!    * toString.
     *
     * @return stringified object

Index: IJournalStatus.java
===================================================================
RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/IJournalStatus.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** IJournalStatus.java	27 Jun 2003 02:19:57 -0000	1.3
--- IJournalStatus.java	30 Jul 2004 01:33:00 -0000	1.4
***************
*** 75,85 ****
   * @version 1.0
   *
!  * @see com.babeldoc.core.JournalStatus
   */
  public interface IJournalStatus extends Serializable {
    /**
!    * Return additional information for this status
     *
!    * @return
     */
    public String getAdditionalInfo();
--- 75,85 ----
   * @version 1.0
   *
!  * @see com.babeldoc.core.journal.JournalStatus
   */
  public interface IJournalStatus extends Serializable {
    /**
!    * Return additional information for this status.
     *
!    * @return additional information.
     */
    public String getAdditionalInfo();

Index: JournalTicket.java
===================================================================
RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/JournalTicket.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** JournalTicket.java	12 Aug 2003 23:44:43 -0000	1.4
--- JournalTicket.java	30 Jul 2004 01:33:00 -0000	1.5
***************
*** 78,86 ****
   */
  public class JournalTicket implements IJournalTicket {
!   /** instance: the ticket value is stored as a long integer */
    long value;

    /**
!    * Construct a tracker ticket
     *
     * @param value the value of this ticket
--- 78,86 ----
   */
  public class JournalTicket implements IJournalTicket {
!   /** instance: the ticket value is stored as a long integer. */
    long value;

    /**
!    * Construct a tracker ticket.
     *
     * @param value the value of this ticket
***************
*** 91,97 ****

    /**
!    * Return dummy tickets - dummy tickets dont do anything
     *
!    * @return
     */
    public static IJournalTicket getDummy() {
--- 91,97 ----

    /**
!    * Return dummy tickets - dummy tickets dont do anything.
     *
!    * @return dummy ticket
     */
    public static IJournalTicket getDummy() {
***************
*** 100,106 ****

    /**
!    * Return dummy tickets - dummy tickets dont do anything
     *
!    * @return
     */
    public boolean isDummy() {
--- 100,106 ----

    /**
!    * Return dummy tickets - dummy tickets dont do anything.
     *
!    * @return is this a dummy ticket?
     */
    public boolean isDummy() {
***************
*** 120,124 ****

    /**
!    * getChild the value of this ticket
     *
     * @return the value of this ticket
--- 120,124 ----

    /**
!    * getChild the value of this ticket.
     *
     * @return the value of this ticket
***************
*** 129,133 ****

    /**
!    * Equality
     *
     * @param id the value to compare
--- 129,133 ----

    /**
!    * Equality.
     *
     * @param id the value to compare

Index: JournalOperation.java
===================================================================
RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/JournalOperation.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** JournalOperation.java	23 Jul 2004 22:31:54 -0000	1.5
--- JournalOperation.java	30 Jul 2004 01:33:00 -0000	1.6
***************
*** 86,109 ****
   */
  public class JournalOperation implements Serializable {
    public static final JournalOperation newTicket = new JournalOperation(0);
    public static final JournalOperation forkTicket = new JournalOperation(1);
    public static final JournalOperation updateStatus = new JournalOperation(2);
    public static final JournalOperation updateDocument = new JournalOperation(3);
    public static final JournalOperation updateJournal = new JournalOperation(4);

!   /** private constants */
    private static final String NEW_TICKET = "newTicket";
    private static final String FORK_TICKET = "forkTicket";
    private static final String UPDATE_STATUS = "updateStatus";
    private static final String UPDATE_DOCUMENT = "updateDocument";
    private static final String UPDATE_JOURNAL = "updateJournal";

!   /** instance variable */
    private int operation;

    /**
!    * Private constructor - please use the statics defined on this class
     *
!    * @param operation
     */
    private JournalOperation(int operation) {
--- 86,118 ----
   */
  public class JournalOperation implements Serializable {
+   /** instance of operation. */
    public static final JournalOperation newTicket = new JournalOperation(0);
+   /** instance of operation. */
    public static final JournalOperation forkTicket = new JournalOperation(1);
+   /** instance of operation. */
    public static final JournalOperation updateStatus = new JournalOperation(2);
+   /** instance of operation. */
    public static final JournalOperation updateDocument = new JournalOperation(3);
+   /** instance of operation. */
    public static final JournalOperation updateJournal = new JournalOperation(4);

!   /** ticket operation. */
    private static final String NEW_TICKET = "newTicket";
+   /** ticket operation. */
    private static final String FORK_TICKET = "forkTicket";
+   /** ticket operation. */
    private static final String UPDATE_STATUS = "updateStatus";
+   /** ticket operation. */
    private static final String UPDATE_DOCUMENT = "updateDocument";
+   /** ticket operation. */
    private static final String UPDATE_JOURNAL = "updateJournal";

!   /** instance variable. */
    private int operation;

    /**
!    * Private constructor - please use the statics defined on this class.
     *
!    * @param operation operation identifier.
     */
    private JournalOperation(int operation) {
***************
*** 114,120 ****
     * return the journaloperation for the string.
     *
!    * @param op
     *
!    * @return
     */
    public static JournalOperation getJournalOperation(String op) {
--- 123,129 ----
     * return the journaloperation for the string.
     *
!    * @param op operation name
     *
!    * @return journal operation
     */
    public static JournalOperation getJournalOperation(String op) {
***************
*** 135,143 ****

    /**
!    * equality operation
     *
     * @param obj comparison object
     *
!    * @return
     */
    public boolean equals(Object obj) {
--- 144,152 ----

    /**
!    * equality operation.
     *
     * @param obj comparison object
     *
!    * @return equality.
     */
    public boolean equals(Object obj) {
***************
*** 146,152 ****

    /**
!    * toString
     *
!    * @return
     */
    public String toString() {
--- 155,161 ----

    /**
!    * toString.
     *
!    * @return stringified object.
     */
    public String toString() {

Index: JournalTest.java
===================================================================
RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/JournalTest.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** JournalTest.java	17 Sep 2003 22:13:20 -0000	1.4
--- JournalTest.java	30 Jul 2004 01:33:00 -0000	1.5
***************
*** 72,94 ****

  /**
!  * JournalTest.  Test the journal.
!  * 
!  * <p>
!  * Title: babel
!  * </p>
!  * 
!  * <p>
!  * Description: universal document processor
!  * </p>
   * 
-  * <p>
-  * Copyright: Copyright (c) 2002
-  * </p>
-  *
   * @author bmcdonald
   * @version 1.0
   */
  public class JournalTest extends TestCase {
!   /** Stuff */
    IJournal journal;

--- 72,82 ----

  /**
!  * A simple JUnit test for the Journal.
   * 
   * @author bmcdonald
   * @version 1.0
   */
  public class JournalTest extends TestCase {
!   /** Stuff. */
    IJournal journal;

***************
*** 96,100 ****
     * Creates a new JournalTest object.
     *
!    * @param testName DOCUMENT ME!
     */
    public JournalTest(String testName) {
--- 84,88 ----
     * Creates a new JournalTest object.
     *
!    * @param testName junit needs this
     */
    public JournalTest(String testName) {
***************
*** 105,109 ****
     * Run all the test methods in this class.
     *
!    * @param args DOCUMENT ME!
     */
    public static void main(String[] args) {
--- 93,97 ----
     * Run all the test methods in this class.
     *
!    * @param args Commandline
     */
    public static void main(String[] args) {
***************
*** 112,118 ****

    /**
!    * Test suite
     *
!    * @return DOCUMENT ME!
     */
    public static Test suite() {
--- 100,106 ----

    /**
!    * Test suite.
     *
!    * @return test object
     */
    public static Test suite() {
***************
*** 123,127 ****

    /**
!    * test forking tickets
     *
     * @throws Exception
--- 111,115 ----

    /**
!    * test forking tickets.
     *
     * @throws Exception
***************
*** 133,137 ****

    /**
!    * test getting new ticket
     *
     * @throws Exception
--- 121,125 ----

    /**
!    * test getting new ticket.
     *
     * @throws Exception
***************
*** 142,146 ****

    /**
!    * test updating document
     *
     * @throws Exception
--- 130,134 ----

    /**
!    * test updating document.
     *
     * @throws Exception
***************
*** 154,158 ****

    /**
!    * testimg i[date statis
     *
     * @throws Exception
--- 142,146 ----

    /**
!    * testimg i[date status.
     *
     * @throws Exception
***************
*** 164,168 ****

    /**
!    * Setup the test
     *
     * @throws Exception
--- 152,156 ----

    /**
!    * Setup the test.
     *
     * @throws Exception
***************
*** 174,178 ****

    /**
!    * Teardown the test
     *
     * @throws Exception
--- 162,166 ----

    /**
!    * Teardown the test.
     *
     * @throws Exception

Index: JournalFactory.java
===================================================================
RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/JournalFactory.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -d -r1.8 -r1.9
*** JournalFactory.java	23 Jul 2004 22:31:54 -0000	1.8
--- JournalFactory.java	30 Jul 2004 01:33:00 -0000	1.9
***************
*** 81,98 ****
   */
  public class JournalFactory {
!   /** constant: configuration name */
    public static final String CONFIG_NAME = "journal/config";

!   /** constant: journal type */
    public static final String JOURNAL_TYPE = "journalType";

!   /** static: holds singleton reference */
    private static JournalFactory instance = null;

!   /** instance: the singletons actual reference to the implementing journal */
    private IJournal journal;

    /**
!    * Constructor is private since this is a singleton
     */
    private JournalFactory() {
--- 81,98 ----
   */
  public class JournalFactory {
!   /** constant: configuration name. */
    public static final String CONFIG_NAME = "journal/config";

!   /** constant: journal type. */
    public static final String JOURNAL_TYPE = "journalType";

!   /** static: holds singleton reference. */
    private static JournalFactory instance = null;

!   /** instance: the singletons actual reference to the implementing journal. */
    private IJournal journal;

    /**
!    * Constructor is private since this is a singleton.
     */
    private JournalFactory() {
***************
*** 115,119 ****

    /**
!    * Get an instance of the singleton - make one if necessary
     *
     * @return trackerfactory object
--- 115,119 ----

    /**
!    * Get an instance of the singleton - make one if necessary.
     *
     * @return trackerfactory object
***************
*** 127,131 ****

    /**
!    * Get a journal object
     *
     * @return the journal object
--- 127,131 ----

    /**
!    * Get a journal object.
     *
     * @return the journal object