Package org.apache.uima.jcas.cas
Class Sofa
java.lang.Object
org.apache.uima.cas.impl.FeatureStructureImpl
org.apache.uima.jcas.cas.TOP
org.apache.uima.jcas.cas.Sofa
- All Implemented Interfaces:
Cloneable
,FeatureStructure
,SofaFS
Updated by JCasGen Fri Apr 29 16:05:04 EDT 2005
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the Local Subject of Analysis returns null if not previously set.Get the Local Subject of Analysis returns null if not previously set.getter for mimeType - getsProvides stream access to both local and remote Sofa data.getter for sofaID - getsGet the Sofa mime type.int
getter for sofaNum - getsint
Get the Sofa Ref value.Get the Sofa URI value.int
used to obtain reference to the TOP_Type instancevoid
setFeatureValue
(Feature feat, FeatureStructure fs) Set a feature value to another FS.void
setIntValue
(Feature feat, Integer val) void
setLocalSofaData
(String aString) Set the Local Subject of Analysis to be a String.void
Set the Local Subject of Analysis to be a predefined ArrayFS.void
setRemoteSofaURI
(String aURI) Set the URI for a Remote Subject of Analysis.void
setStringValue
(Feature feat, String val) Set the string value of a feature.Methods inherited from class org.apache.uima.jcas.cas.TOP
addToIndexes, addToIndexes, equals, getAddress, getCAS, getCASImpl, getLowLevelCas, hashCode, removeFromIndexes, removeFromIndexes
Methods inherited from class org.apache.uima.cas.impl.FeatureStructureImpl
clone, getavoidcollisionTypeCode, getBooleanValue, getByteValue, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getLongValue, getShortValue, getStringValue, getType, prettyPrint, prettyPrint, prettyPrint, setBooleanValue, setByteValue, setDoubleValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, toString, toString
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.uima.cas.FeatureStructure
clone, equals, getBooleanValue, getByteValue, getCAS, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getLongValue, getShortValue, getStringValue, getType, hashCode, setBooleanValue, setByteValue, setDoubleValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue
-
Field Details
-
typeIndexID
public static final int typeIndexID -
type
public static final int type
-
-
Constructor Details
-
Sofa
protected Sofa()Never called. Disable default constructor -
Sofa
Internal - constructor used by generator- Parameters:
addr
- the addresstype
- the type
-
Sofa
Deprecated.As of v2.0, useJCasImpl.createView(String)
to create a view, which will also create the Sofa for that view.- Parameters:
jcas
- JCasID
- the sofa IDmimeType
- the mime type
-
-
Method Details
-
getTypeIndexID
public int getTypeIndexID()Description copied from class:TOP
used to obtain reference to the TOP_Type instance- Overrides:
getTypeIndexID
in classTOP
- Returns:
- the type array index
-
getSofaNum
public int getSofaNum()getter for sofaNum - gets- Returns:
- the sofa number
-
getSofaID
getter for sofaID - gets -
getMimeType
getter for mimeType - gets- Returns:
- the mime type
-
setLocalSofaData
Description copied from interface:SofaFS
Set the Local Subject of Analysis to be a predefined ArrayFS. Once set, the Sofa data cannot be changed.- Specified by:
setLocalSofaData
in interfaceSofaFS
- Parameters:
aFS
- the SofA- See Also:
-
setLocalSofaData
Description copied from interface:SofaFS
Set the Local Subject of Analysis to be a String. Once set, the Sofa data cannot be changed.- Specified by:
setLocalSofaData
in interfaceSofaFS
- Parameters:
aString
- The subject of analysis- See Also:
-
getLocalFSData
Description copied from interface:SofaFS
Get the Local Subject of Analysis returns null if not previously set.- Specified by:
getLocalFSData
in interfaceSofaFS
- Returns:
- the local SofA
- See Also:
-
getLocalStringData
Description copied from interface:SofaFS
Get the Local Subject of Analysis returns null if not previously set.- Specified by:
getLocalStringData
in interfaceSofaFS
- Returns:
- the SofA
- See Also:
-
setRemoteSofaURI
Description copied from interface:SofaFS
Set the URI for a Remote Subject of Analysis. Once set, this URI may not be changed.- Specified by:
setRemoteSofaURI
in interfaceSofaFS
- Parameters:
aURI
- the URI for a remote Sofa- See Also:
-
setStringValue
Description copied from interface:FeatureStructure
Set the string value of a feature.- Specified by:
setStringValue
in interfaceFeatureStructure
- Overrides:
setStringValue
in classFeatureStructureImpl
- Parameters:
feat
- The feature whose value we want to set.val
- The string we're setting the feature to.
-
setFeatureValue
Description copied from interface:FeatureStructure
Set a feature value to another FS.- Specified by:
setFeatureValue
in interfaceFeatureStructure
- Overrides:
setFeatureValue
in classFeatureStructureImpl
- Parameters:
feat
- The feature whose value should be set.fs
- The value FS.
-
setIntValue
-
getSofaMime
Description copied from interface:SofaFS
Get the Sofa mime type.- Specified by:
getSofaMime
in interfaceSofaFS
- Returns:
- SofA mime type
-
getSofaURI
Description copied from interface:SofaFS
Get the Sofa URI value.- Specified by:
getSofaURI
in interfaceSofaFS
- Returns:
- Sofa URI or null if not valid
-
getSofaRef
public int getSofaRef()Description copied from interface:SofaFS
Get the Sofa Ref value.- Specified by:
getSofaRef
in interfaceSofaFS
- Returns:
- the Sofa Reference value
-
getSofaDataStream
Description copied from interface:SofaFS
Provides stream access to both local and remote Sofa data. For remote SofA data, a custom URLStreamHandler may be registered for a protocol via the java.protocol.handler.pkgs system property.- Specified by:
getSofaDataStream
in interfaceSofaFS
- Returns:
- an InputStream for reading Sofa data. null returned if there is no Sofa data.
-
JCasImpl.createView(String)
to create a view, which will also create the Sofa for that view.