Package org.apache.uima.jcas.cas
Class TOP
java.lang.Object
org.apache.uima.cas.impl.FeatureStructureImpl
org.apache.uima.jcas.cas.TOP
- All Implemented Interfaces:
Cloneable
,FeatureStructure
- Direct Known Subclasses:
AnnotationBase
,BooleanArray
,ByteArray
,DoubleArray
,FloatArray
,FloatList
,FSArray
,FSList
,IntegerArray
,IntegerList
,LongArray
,ShortArray
,Sofa
,StringArray
,StringList
The Java Class model corresponding to the Cas TOP type. This type is the super type of all
feature structures. This type implements FeatureStructure since subclasses of it are the FSs
generated by this system.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final int
used to reference the corresponding Cas instanceused to reference the corresponding TOP_Type instancestatic final int
static final int
Each cover class when loaded sets an index. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
add the corresponding FeatureStructure to all Cas indexes in the view where this FS was createdvoid
addToIndexes
(JCas jcas) add this FS to indexes in a specific view, perhaps different from the creation viewboolean
A feature structure is equal to another feature structure iff it is identical in the underlying representation.int
getCAS()
Return the CAS that this FS belongs to.int
used to obtain reference to the TOP_Type instanceint
hashCode()
Will return a hash code that's consistent with equality, i.e., if two FSs are equal, they will also return the same hash code.void
remove the corresponding FeatureStructure from all Cas indexes in the view where this FS was createdvoid
removeFromIndexes
(JCas jcas) remove this FS from indexes in a specific view, perhaps different from the view where this was created.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, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString, toString
-
Field Details
-
typeIndexID
public static final int typeIndexIDEach cover class when loaded sets an index. Used in the JCas typeArray to go from the cover class or class instance to the corresponding instance of the _Type class -
type
public static final int type -
jcasType
used to reference the corresponding TOP_Type instance -
addr
protected final int addrused to reference the corresponding Cas instance
-
-
Constructor Details
-
TOP
protected TOP() -
TOP
-
TOP
-
-
Method Details
-
getTypeIndexID
public int getTypeIndexID()used to obtain reference to the TOP_Type instance- Returns:
- the type array index
-
addToIndexes
public void addToIndexes()add the corresponding FeatureStructure to all Cas indexes in the view where this FS was created -
addToIndexes
add this FS to indexes in a specific view, perhaps different from the creation view- Parameters:
jcas
- the JCas
-
removeFromIndexes
public void removeFromIndexes()remove the corresponding FeatureStructure from all Cas indexes in the view where this FS was created -
removeFromIndexes
remove this FS from indexes in a specific view, perhaps different from the view where this was created.- Parameters:
jcas
- the JCas
-
getAddress
public int getAddress()- Specified by:
getAddress
in classFeatureStructureImpl
-
getCASImpl
- Specified by:
getCASImpl
in classFeatureStructureImpl
-
getCAS
Description copied from interface:FeatureStructure
Return the CAS that this FS belongs to.- Returns:
- the CAS view where this FS was created
-
getLowLevelCas
-
equals
Description copied from interface:FeatureStructure
A feature structure is equal to another feature structure iff it is identical in the underlying representation.- Specified by:
equals
in interfaceFeatureStructure
- Overrides:
equals
in classObject
-
hashCode
public int hashCode()Description copied from interface:FeatureStructure
Will return a hash code that's consistent with equality, i.e., if two FSs are equal, they will also return the same hash code.- Specified by:
hashCode
in interfaceFeatureStructure
- Overrides:
hashCode
in classObject
- Returns:
- The hash code.
-