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:
java.lang.Cloneable
,FeatureStructure
,FeatureStructureImpl
,SofaFSImpl
,SofaFS
public class Sofa extends TOP implements SofaFSImpl
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.uima.cas.impl.FeatureStructureImplC
FeatureStructureImplC.PrintReferences
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.invoke.CallSite
_FC_mimeType
private static java.lang.invoke.CallSite
_FC_sofaArray
private static java.lang.invoke.CallSite
_FC_sofaID
private static java.lang.invoke.CallSite
_FC_sofaNum
private static java.lang.invoke.CallSite
_FC_sofaString
private static java.lang.invoke.CallSite
_FC_sofaURI
static java.lang.String
_FeatName_mimeType
static java.lang.String
_FeatName_sofaArray
static java.lang.String
_FeatName_sofaID
static java.lang.String
_FeatName_sofaNum
static java.lang.String
_FeatName_sofaString
static java.lang.String
_FeatName_sofaURI
private static java.lang.invoke.MethodHandle
_FH_mimeType
private static java.lang.invoke.MethodHandle
_FH_sofaArray
private static java.lang.invoke.MethodHandle
_FH_sofaID
private static java.lang.invoke.MethodHandle
_FH_sofaNum
private static java.lang.invoke.MethodHandle
_FH_sofaString
private static java.lang.invoke.MethodHandle
_FH_sofaURI
static java.lang.String
_TypeName
static int
type
static int
typeIndexID
-
Fields inherited from class org.apache.uima.jcas.cas.TOP
_singleton
-
Fields 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
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FeatureStructure
getLocalFSData()
Get the Local Subject of Analysis returns null if not previously set.java.lang.String
getLocalStringData()
Get the Local Subject of Analysis returns null if not previously set.java.lang.String
getMimeType()
getter for mimeType - getsTOP
getSofaArray()
These getter methods are for creating method handle access The getter name must match the feature name + transformation - used in generic pretty printing routinesjava.io.InputStream
getSofaDataStream()
Provides stream access to both local and remote Sofa data.java.lang.String
getSofaID()
getter for sofaIDjava.lang.String
getSofaMime()
Get the Sofa mime type.int
getSofaNum()
getter for sofaNumint
getSofaRef()
Get the Sofa Ref value.java.lang.String
getSofaString()
java.lang.String
getSofaURI()
Get the Sofa URI value.int
getTypeIndexID()
boolean
isSofaDataSet()
void
setFeatureValue(Feature feat, FeatureStructure fs)
Set a feature value to another FS.void
setIntValue(Feature feat, java.lang.Integer val)
void
setLocalSofaData(java.lang.String aString)
Set the Local Subject of Analysis to be a String.void
setLocalSofaData(java.lang.String aString, java.lang.String mimeType)
void
setLocalSofaData(FeatureStructure aFS)
Set the Local Subject of Analysis to be a predefined ArrayFS.void
setLocalSofaData(FeatureStructure aFS, java.lang.String mimeType)
void
setLocalSofaDataNoDocAnnotUpdate(java.lang.String aString)
Internal use: used by deserializersvoid
setMimeType(java.lang.String v)
void
setRemoteSofaURI(java.lang.String aURI)
Set the URI for a Remote Subject of Analysis.void
setRemoteSofaURI(java.lang.String aURI, java.lang.String mimeType)
void
setStringValue(Feature feat, java.lang.String val)
Set the string value of a feature.private void
throwAlreadySet(java.lang.String msg)
-
Methods inherited from class org.apache.uima.jcas.cas.TOP
_createJCasHashMapReserve, _createSearchKey
-
Methods 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, wrapGetIntCatchException
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods 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 Detail
-
_TypeName
public static final java.lang.String _TypeName
- See Also:
- Constant Field Values
-
_FeatName_sofaNum
public static final java.lang.String _FeatName_sofaNum
- See Also:
- Constant Field Values
-
_FeatName_sofaID
public static final java.lang.String _FeatName_sofaID
- See Also:
- Constant Field Values
-
_FeatName_mimeType
public static final java.lang.String _FeatName_mimeType
- See Also:
- Constant Field Values
-
_FeatName_sofaArray
public static final java.lang.String _FeatName_sofaArray
- See Also:
- Constant Field Values
-
_FeatName_sofaString
public static final java.lang.String _FeatName_sofaString
- See Also:
- Constant Field Values
-
_FeatName_sofaURI
public static final java.lang.String _FeatName_sofaURI
- See Also:
- Constant Field Values
-
typeIndexID
public static final int typeIndexID
-
type
public static final int type
-
_FC_sofaNum
private static final java.lang.invoke.CallSite _FC_sofaNum
-
_FC_sofaID
private static final java.lang.invoke.CallSite _FC_sofaID
-
_FC_mimeType
private static final java.lang.invoke.CallSite _FC_mimeType
-
_FC_sofaArray
private static final java.lang.invoke.CallSite _FC_sofaArray
-
_FC_sofaString
private static final java.lang.invoke.CallSite _FC_sofaString
-
_FC_sofaURI
private static final java.lang.invoke.CallSite _FC_sofaURI
-
_FH_sofaNum
private static final java.lang.invoke.MethodHandle _FH_sofaNum
-
_FH_sofaID
private static final java.lang.invoke.MethodHandle _FH_sofaID
-
_FH_mimeType
private static final java.lang.invoke.MethodHandle _FH_mimeType
-
_FH_sofaArray
private static final java.lang.invoke.MethodHandle _FH_sofaArray
-
_FH_sofaString
private static final java.lang.invoke.MethodHandle _FH_sofaString
-
_FH_sofaURI
private static final java.lang.invoke.MethodHandle _FH_sofaURI
-
-
Method Detail
-
getTypeIndexID
public int getTypeIndexID()
- Overrides:
getTypeIndexID
in classTOP
- Returns:
- the type array index
-
getSofaNum
public int getSofaNum()
getter for sofaNum- Specified by:
getSofaNum
in interfaceSofaFS
- Returns:
- the sofa number
-
getSofaID
public java.lang.String getSofaID()
getter for sofaID
-
getMimeType
public java.lang.String getMimeType()
getter for mimeType - gets- Returns:
- the mime type
-
setLocalSofaData
public void setLocalSofaData(FeatureStructure aFS)
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:
This method is duplicated in SofaFSImpl. Any changes should be made in both places. aFS must be an array
-
setLocalSofaData
public void setLocalSofaData(FeatureStructure aFS, java.lang.String mimeType)
-
setLocalSofaData
public void setLocalSofaData(java.lang.String aString)
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:
SofaFS.setLocalSofaData(String)
-
setLocalSofaDataNoDocAnnotUpdate
public void setLocalSofaDataNoDocAnnotUpdate(java.lang.String aString)
Internal use: used by deserializers- Parameters:
aString
- the string to update
-
setLocalSofaData
public void setLocalSofaData(java.lang.String aString, java.lang.String mimeType)
-
getLocalFSData
public FeatureStructure 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:
returns an UIMA Array whose data represents the sofa
-
getLocalStringData
public java.lang.String 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:
SofaFS.getLocalStringData()
-
setRemoteSofaURI
public void setRemoteSofaURI(java.lang.String aURI)
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:
This method is duplicated in SofaFSImpl. Any changes should be made in both places.
-
setRemoteSofaURI
public void setRemoteSofaURI(java.lang.String aURI, java.lang.String mimeType)
-
isSofaDataSet
public boolean isSofaDataSet()
-
getSofaMime
public java.lang.String getSofaMime()
Description copied from interface:SofaFS
Get the Sofa mime type.- Specified by:
getSofaMime
in interfaceSofaFS
- Returns:
- SofA mime type
-
getSofaURI
public java.lang.String 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
public java.io.InputStream 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.
-
getSofaArray
public TOP 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
public java.lang.String getSofaString()
-
setStringValue
public void setStringValue(Feature feat, java.lang.String val)
Description copied from interface:FeatureStructure
Set the string value of a feature.- Specified by:
setStringValue
in interfaceFeatureStructure
- Overrides:
setStringValue
in classFeatureStructureImplC
- Parameters:
feat
- The feature whose value we want to set.val
- The string we're setting the feature to.
-
setFeatureValue
public void setFeatureValue(Feature feat, FeatureStructure fs)
Description copied from interface:FeatureStructure
Set a feature value to another FS.- Specified by:
setFeatureValue
in interfaceFeatureStructure
- Overrides:
setFeatureValue
in classFeatureStructureImplC
- Parameters:
feat
- The feature whose value should be set.fs
- The value FS.
-
setIntValue
public void setIntValue(Feature feat, java.lang.Integer val)
-
throwAlreadySet
private void throwAlreadySet(java.lang.String msg)
-
setMimeType
public void setMimeType(java.lang.String v)
-
-