Package org.apache.uima.jcas.cas
Class Sofa
java.lang.Object
org.apache.uima.cas.impl.FeatureStructureImplC
org.apache.uima.jcas.cas.TOP
org.apache.uima.jcas.cas.Sofa
- All Implemented Interfaces:
Cloneable,FeatureStructure,FeatureStructureImpl,SofaFSImpl,SofaFS
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.uima.cas.impl.FeatureStructureImplC
FeatureStructureImplC.PrintReferences -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final intstatic final intFields inherited from class org.apache.uima.jcas.cas.TOP
_singletonFields inherited from class org.apache.uima.cas.impl.FeatureStructureImplC
_casView, _id, DISABLE_RUNTIME_FEATURE_VALIDATION, DISABLE_RUNTIME_FEATURE_VALUE_VALIDATION, IS_ENABLE_RUNTIME_FEATURE_VALIDATION, IS_ENABLE_RUNTIME_FEATURE_VALUE_VALIDATION, IS_V2_PRETTY_PRINT, V2_PRETTY_PRINT -
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 - getsThese getter methods are for creating method handle access The getter name must match the feature name + transformation - used in generic pretty printing routinesProvides stream access to both local and remote Sofa data.getter for sofaIDGet the Sofa mime type.intgetter for sofaNumintGet the Sofa Ref value.Get the Sofa URI value.intbooleanvoidsetFeatureValue(Feature feat, FeatureStructure fs) Set a feature value to another FS.voidsetIntValue(Feature feat, Integer val) voidsetLocalSofaData(String aString) Set the Local Subject of Analysis to be a String.voidsetLocalSofaData(String aString, String mimeType) voidSet the Local Subject of Analysis to be a predefined ArrayFS.voidsetLocalSofaData(FeatureStructure aFS, String mimeType) voidsetLocalSofaDataNoDocAnnotUpdate(String aString) Internal use: used by deserializersvoidvoidsetRemoteSofaURI(String aURI) Set the URI for a Remote Subject of Analysis.voidsetRemoteSofaURI(String aURI, String mimeType) voidsetStringValue(Feature feat, String val) Set the string value of a feature.Methods inherited from class org.apache.uima.jcas.cas.TOP
_createJCasHashMapReserve, _createSearchKeyMethods inherited from class org.apache.uima.cas.impl.FeatureStructureImplC
_copyIntAndRefArraysEqTypesFrom, _copyIntAndRefArraysFrom, _copyIntArrayEqTypesFrom, _getBooleanValueNc, _getBooleanValueNc, _getByteValueNc, _getByteValueNc, _getDoubleValueNc, _getDoubleValueNc, _getFeatFromAdjOffset, _getFeatureValueNc, _getFeatureValueNc, _getFloatValueNc, _getFloatValueNc, _getIntLikeValue, _getIntValueNc, _getIntValueNc, _getLongValueNc, _getLongValueNc, _getRefValueCommon, _getShortValueNc, _getShortValueNc, _getStringValueNc, _getStringValueNc, _getTypeCode, _getTypeImpl, _getView, _id, _inSetSortedIndex, _isJCasHashMapReserve, _isPearTrampoline, _maybeGetBaseForPearFs, _maybeGetBaseForPearFs, _maybeGetPearFs, _maybeGetPearFs, _resetInSetSortedIndex, _setBooleanValueNcNj, _setBooleanValueNcNj, _setBooleanValueNfc, _setByteValueNcNj, _setByteValueNcNj, _setByteValueNfc, _setDoubleValueNcNj, _setDoubleValueNcNj, _setDoubleValueNfc, _setFeatureValueNcNj, _setFeatureValueNcNj, _setFeatureValueNcWj, _setFloatValueNcNj, _setFloatValueNcNj, _setFloatValueNfc, _setInSetSortedIndexed, _setIntLikeValue, _setIntLikeValueNcNj, _setIntValueCJ, _setIntValueNcNj, _setIntValueNcNj, _setIntValueNfc, _setIntValueNfcCJ, _setJCasHashMapReserve, _setLongValueCJ, _setLongValueNcNj, _setLongValueNcNj, _setLongValueNfc, _setLongValueNfcCJ, _setPearTrampoline, _setRefValueCJ, _setRefValueCommon, _setRefValueCommonWj, _setRefValueNfcCJ, _setShortValueNcNj, _setShortValueNcNj, _setShortValueNfc, _setStringValueNcNj, _setStringValueNcWj, _setStringValueNfc, _setTypeImpl, addStringOrPrimitive, addToIndexes, addToIndexes, addToIndexes, clone, compare, equals, getAddress, getBooleanValue, getByteValue, getCAS, getCASImpl, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getLongValue, getLowLevelCas, getShortValue, getStringValue, getType, hashCode, prettyPrint, prettyPrint, prettyPrint, prettyPrint, prettyPrint, prettyPrint, prettyPrintShort, removeFromIndexes, removeFromIndexes, removeFromIndexes, setBooleanValue, setByteValue, setDoubleValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, toShortString, toString, toString, wrapGetIntCatchExceptionMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.uima.cas.FeatureStructure
_getTypeCode, _id, clone, equals, getAddress, getBooleanValue, getByteValue, getCAS, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getJCas, getLongValue, getShortValue, getStringValue, getType, hashCode, setBooleanValue, setByteValue, setDoubleValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue
-
Field Details
-
_TypeName
- See Also:
-
_FeatName_sofaNum
- See Also:
-
_FeatName_sofaID
- See Also:
-
_FeatName_mimeType
- See Also:
-
_FeatName_sofaArray
- See Also:
-
_FeatName_sofaString
- See Also:
-
_FeatName_sofaURI
- See Also:
-
typeIndexID
public static final int typeIndexID -
type
public static final int type
-
-
Constructor Details
-
Sofa
protected Sofa() -
Sofa
used by generator, not used Make a new Sofa- Parameters:
c- -t- -
-
Sofa
-
-
Method Details
-
getTypeIndexID
public int getTypeIndexID()- Overrides:
getTypeIndexIDin classTOP- Returns:
- the type array index
-
getSofaNum
public int getSofaNum()getter for sofaNum- Specified by:
getSofaNumin interfaceSofaFS- Returns:
- the sofa number
-
getSofaID
getter for sofaID -
getMimeType
getter for mimeType - gets- Returns:
- the mime type
-
setLocalSofaData
Description copied from interface:SofaFSSet the Local Subject of Analysis to be a predefined ArrayFS. Once set, the Sofa data cannot be changed.- Specified by:
setLocalSofaDatain interfaceSofaFS- Parameters:
aFS- the SofA- See Also:
-
setLocalSofaData
-
setLocalSofaData
Description copied from interface:SofaFSSet the Local Subject of Analysis to be a String. Once set, the Sofa data cannot be changed.- Specified by:
setLocalSofaDatain interfaceSofaFS- Parameters:
aString- The subject of analysis- See Also:
-
setLocalSofaDataNoDocAnnotUpdate
Internal use: used by deserializers- Parameters:
aString- the string to update
-
setLocalSofaData
-
getLocalFSData
Description copied from interface:SofaFSGet the Local Subject of Analysis returns null if not previously set.- Specified by:
getLocalFSDatain interfaceSofaFS- Returns:
- the local SofA
- See Also:
-
getLocalStringData
Description copied from interface:SofaFSGet the Local Subject of Analysis returns null if not previously set.- Specified by:
getLocalStringDatain interfaceSofaFS- Returns:
- the SofA
- See Also:
-
setRemoteSofaURI
Description copied from interface:SofaFSSet the URI for a Remote Subject of Analysis. Once set, this URI may not be changed.- Specified by:
setRemoteSofaURIin interfaceSofaFS- Parameters:
aURI- the URI for a remote Sofa- See Also:
-
setRemoteSofaURI
-
isSofaDataSet
public boolean isSofaDataSet() -
getSofaMime
Description copied from interface:SofaFSGet the Sofa mime type.- Specified by:
getSofaMimein interfaceSofaFS- Returns:
- SofA mime type
-
getSofaURI
Description copied from interface:SofaFSGet the Sofa URI value.- Specified by:
getSofaURIin interfaceSofaFS- Returns:
- Sofa URI or null if not valid
-
getSofaRef
public int getSofaRef()Description copied from interface:SofaFSGet the Sofa Ref value.- Specified by:
getSofaRefin interfaceSofaFS- Returns:
- the Sofa Reference value
-
getSofaDataStream
Description copied from interface:SofaFSProvides 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:
getSofaDataStreamin interfaceSofaFS- Returns:
- an InputStream for reading Sofa data. null returned if there is no Sofa data.
-
getSofaArray
These getter methods are for creating method handle access The getter name must match the feature name + transformation - used in generic pretty printing routines- Returns:
- -
-
getSofaString
-
setStringValue
Description copied from interface:FeatureStructureSet the string value of a feature.- Specified by:
setStringValuein interfaceFeatureStructure- Overrides:
setStringValuein classFeatureStructureImplC- Parameters:
feat- The feature whose value we want to set.val- The string we're setting the feature to.
-
setFeatureValue
Description copied from interface:FeatureStructureSet a feature value to another FS.- Specified by:
setFeatureValuein interfaceFeatureStructure- Overrides:
setFeatureValuein classFeatureStructureImplC- Parameters:
feat- The feature whose value should be set.fs- The value FS.
-
setIntValue
-
setMimeType
-