svn commit: r1060609 - /incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/coref/mention/Parse.java

[jo...@apache.org]

Author: joern
Date: Tue Jan 18 22:54:11 2011
New Revision: 1060609

URL: http://svn.apache.org/viewvc?rev=1060609&view=rev
Log:
OPENNLP-24: Formated comments

Modified:
    incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/coref/mention/Parse.java

Modified: incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/coref/mention/Parse.java
URL: http://svn.apache.org/viewvc/incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/coref/mention/Parse.java?rev=1060609&r1=1060608&r2=1060609&view=diff
==============================================================================
--- incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/coref/mention/Parse.java (original)
+++ incubator/opennlp/trunk/opennlp-tools/src/main/java/opennlp/tools/coref/mention/Parse.java Tue Jan 18 22:54:11 2011
@@ -29,6 +29,7 @@ public interface Parse extends Comparabl
 
   /**
    * Returns the index of the sentence which contains this parse.
+   * 
    * @return The index of the sentence which contains this parse.
    */
   public int getSentenceNumber();
@@ -37,6 +38,7 @@ public interface Parse extends Comparabl
    * Returns a list of the all noun phrases
    * contained by this parse.  The noun phrases in this list should
    * also implement the {@link Parse} interface.
+   * 
    * @return a list of all the noun phrases contained by this parse.
    */
   public List<Parse> getNounPhrases();
@@ -45,12 +47,14 @@ public interface Parse extends Comparabl
    * Returns a list of all the named entities
    * contained by this parse.  The named entities in this list should
    * also implement the {@link Parse} interface.
+   * 
    * @return a list of all the named entities contained by this parse. */
   public List<Parse> getNamedEntities();
 
   /** 
    * Returns a list of the children to this object.  The
-   * children should also implement the {@link Parse} interface.
+   * children should also implement the {@link Parse} interface
+   * .
    * @return a list of the children to this object.
    * */
   public List<Parse> getChildren();
@@ -60,6 +64,7 @@ public interface Parse extends Comparabl
    * children should also implement the {@link Parse} interface.  This allows
    * implementations which contain addition nodes for things such as semantic categories to
    * hide those nodes from the components which only care about syntactic nodes.
+   * 
    * @return a list of the children to this object which are constituents or tokens.
    */
   public List<Parse> getSyntacticChildren();
@@ -75,53 +80,63 @@ public interface Parse extends Comparabl
   /** 
    * Returns the syntactic type of this node. Typically this is the part-of-speech or
    * constituent labeling.
+   * 
    * @return the syntactic type.
    */
   public String getSyntacticType();
 
   /** 
    * Returns the named-entity type of this node.
-   * @return the named-entity type. */
+   * 
+   * @return the named-entity type. 
+   */
   public String getEntityType();
 
   /** 
    * Determines whether this has an ancestor of type NAC.
+   * 
    * @return true is this has an ancestor of type NAC, false otherwise.
    */
   public boolean isParentNAC();
 
   /**
    * Returns the parent parse of this parse node.
+   * 
    * @return the parent parse of this parse node.
    */
   public Parse getParent();
 
   /**
    * Specifies whether this parse is a named-entity.
+   * 
    * @return True if this parse is a named-entity; false otherwise.
    */
   public boolean isNamedEntity();
 
   /**
    * Specifies whether this parse is a noun phrase.
+   * 
    * @return True if this parse is a noun phrase; false otherwise.
    */
   public boolean isNounPhrase();
 
   /**
    * Specifies whether this parse is a sentence.
+   * 
    * @return True if this parse is a sentence; false otherwise.
    */
   public boolean isSentence();
 
   /**
    * Specifies whether this parse is a coordinated noun phrase.
+   * 
    * @return True if this parse is a coordinated noun phrase; false otherwise.
    */
   public boolean isCoordinatedNounPhrase();
 
   /** 
    * Specifies whether this parse is a token.
+   * 
    * @return True if this parse is a token; false otherwise.
    */
   public boolean isToken();
@@ -131,12 +146,14 @@ public interface Parse extends Comparabl
   /** 
    * Returns an entity id associated with this parse and coreferent parses.  This is only used for training on
    * already annotated coreference annotation.
+   * 
    * @return an entity id associated with this parse and coreferent parses.
    */
   public int getEntityId();
 
   /**
    * Returns the character offsets of this parse node.
+   * 
    * @return The span representing the character offsets of this parse node.
    */
   public Span getSpan();
@@ -144,6 +161,7 @@ public interface Parse extends Comparabl
   /**
    * Returns the first token which is not a child of this parse.  If the first token of a sentence is
    * a child of this parse then null is returned.
+   * 
    * @return the first token which is not a child of this parse or null if no such token exists.
    */
   public Parse getPreviousToken();
@@ -151,6 +169,7 @@ public interface Parse extends Comparabl
   /**
    * Returns the next token which is not a child of this parse.  If the last token of a sentence is
    * a child of this parse then null is returned.
+   * 
    * @return the next token which is not a child of this parse or null if no such token exists.
    */
   public Parse getNextToken();