You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by al...@apache.org on 2007/01/18 16:48:16 UTC
svn commit: r497465 - in
/incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima:
cas/CAS.java jcas/JCas.java
Author: alally
Date: Thu Jan 18 07:48:16 2007
New Revision: 497465
URL: http://svn.apache.org/viewvc?view=rev&rev=497465
Log:
Fixed up JavaDoc
UIMA-207: https://issues.apache.org/jira/browse/UIMA-207
Modified:
incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java
incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/JCas.java
Modified: incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java?view=diff&rev=497465&r1=497464&r2=497465
==============================================================================
--- incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java (original)
+++ incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/cas/CAS.java Thu Jan 18 07:48:16 2007
@@ -591,6 +591,11 @@
* Create a view and its underlying Sofa (subject of analysis). The view provides access to the
* Sofa data and the index repository that contains metadata (annotations and other feature
* structures) pertaining to that Sofa.
+ * <p>
+ * This method creates the underlying Sofa feature structure, but does not set the Sofa data.
+ * Setting ths Sofa data must be done by calling {@link #setSofaDataArray(FeatureStructure, String)},
+ * {@link #setSofaDataString(String, String)} or {@link #setSofaDataURI(String, String)} on the
+ * CAS view returned by this method.
*
* @param localViewName
* the local name, before any sofa name mapping is done, for this view (note: this is the
@@ -609,7 +614,7 @@
* @param aSofa
* a Sofa feature structure in this CAS.
*
- * @return The JCas for the given Sofa.
+ * @return The JCas view for the given Sofa.
*/
JCas getJCas(SofaFS aSofa) throws CASException;
Modified: incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/JCas.java
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/JCas.java?view=diff&rev=497465&r1=497464&r2=497465
==============================================================================
--- incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/JCas.java (original)
+++ incubator/uima/uimaj/trunk/uimaj-core/src/main/java/org/apache/uima/jcas/JCas.java Thu Jan 18 07:48:16 2007
@@ -164,12 +164,50 @@
*/
public abstract Sofa getSofa(SofaID sofaID);
+ /**
+ * Get the Sofa feature structure associated with this JCas view.
+ *
+ * @return The SofaFS associated with this JCas view.
+ */
public abstract Sofa getSofa();
+ /**
+ * Create a view and its underlying Sofa (subject of analysis). The view provides access to the
+ * Sofa data and the index repository that contains metadata (annotations and other feature
+ * structures) pertaining to that Sofa.
+ * <p>
+ * This method creates the underlying Sofa feature structure, but does not set the Sofa data.
+ * Setting ths Sofa data must be done by calling {@link #setSofaDataArray(FeatureStructure, String)},
+ * {@link #setSofaDataString(String, String)} or {@link #setSofaDataURI(String, String)} on the
+ * JCas view returned by this method.
+ *
+ * @param localViewName
+ * the local name, before any sofa name mapping is done, for this view (note: this is the
+ * same as the associated Sofa name).
+ *
+ * @return The view corresponding to this local name.
+ * @throws CASRuntimeException
+ * if a View with this name already exists in this CAS
+ */
public abstract JCas createView(String sofaID) throws CASException;
+ /**
+ * Create a JCas view for a Sofa.
+ *
+ * @param aSofa
+ * a Sofa feature structure in this CAS.
+ *
+ * @return The JCas view for the given Sofa.
+ */
public abstract JCas getJCas(Sofa sofa) throws CASException;
+ /**
+ * Gets the JCas-based interface to the Index Repository. Provides the same functionality
+ * as {@link #getFSIndexRepository()} except that the methods that take a "type"
+ * argument take type arguments obtainable easily from the JCas type.
+ *
+ * @return the JCas-based interface to the index repository
+ */
public abstract JFSIndexRepository getJFSIndexRepository();
/**