Package org.apache.uima.jcas.cas
Class FSArray
java.lang.Object
org.apache.uima.cas.impl.FeatureStructureImpl
org.apache.uima.jcas.cas.TOP
org.apache.uima.jcas.cas.FSArray
- All Implemented Interfaces:
Cloneable
,ArrayFS
,CommonArrayFS
,FeatureStructure
Java Class model for Cas FSArray type
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
each cover class when loaded sets an index. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
copyFromArray
(String[] src, int srcOffset, int destOffset, int length) Not supported, will throw UnsupportedOperationExceptionvoid
copyFromArray
(FeatureStructure[] src, int srcOffset, int destOffset, int length) Copy the contents of an external array into this array.void
copyToArray
(int srcOffset, String[] dest, int destOffset, int length) Copies an array of Feature Structures to an Array of Strings.void
copyToArray
(int srcOffset, FeatureStructure[] dest, int destOffset, int length) Copy the contents of the array fromstart
toend
to the destinationdestArray
with destination offsetdestOffset
.get
(int i) return the indexed value from the corresponding Cas FSArray as a Java Model object.int
used to obtain reference to the _Type instancevoid
set
(int i, FeatureStructure v) updates the Cas, setting the indexed value with the corresponding Cas FeatureStructure.int
size()
return the size of the array.toArray()
Creates a new array the this array is copied to.String[]
Creates a new string array and copies this array values into it.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, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, 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, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue
-
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
-
-
Constructor Details
-
FSArray
private FSArray() -
FSArray
-
FSArray
Make a new FSArray of given size- Parameters:
jcas
- The JCaslength
- The number of elements in the new array
-
-
Method Details
-
getTypeIndexID
public int getTypeIndexID()used to obtain reference to the _Type instance- Overrides:
getTypeIndexID
in classTOP
- Returns:
- the type array index
-
get
return the indexed value from the corresponding Cas FSArray as a Java Model object. -
set
updates the Cas, setting the indexed value with the corresponding Cas FeatureStructure. -
size
public int size()return the size of the array.- Specified by:
size
in interfaceArrayFS
- Specified by:
size
in interfaceCommonArrayFS
- Returns:
- The size of the array.
-
copyFromArray
Description copied from interface:ArrayFS
Copy the contents of an external array into this array.- Specified by:
copyFromArray
in interfaceArrayFS
- Parameters:
src
- The source array.srcOffset
- Where to start copying in the source array.destOffset
- Where to start copying to in the destination array.length
- The number of elements to copy.- See Also:
-
copyToArray
Description copied from interface:ArrayFS
Copy the contents of the array fromstart
toend
to the destinationdestArray
with destination offsetdestOffset
.- Specified by:
copyToArray
in interfaceArrayFS
- Parameters:
srcOffset
- The index of the first element to copy.dest
- The array to copy to.destOffset
- Where to start copying intodest
.length
- The number of elements to copy.- See Also:
-
toArray
Description copied from interface:ArrayFS
Creates a new array the this array is copied to. -
copyFromArray
Not supported, will throw UnsupportedOperationException- Specified by:
copyFromArray
in interfaceCommonArrayFS
- Parameters:
src
- The source array.srcOffset
- Where to start copying in the source array.destOffset
- Where to start copying to in the destination array.length
- The number of elements to copy.
-
copyToArray
Copies an array of Feature Structures to an Array of Strings. The strings are the "toString()" representation of the feature structures, which are probably something that looks like FeatureStructure@123456- Specified by:
copyToArray
in interfaceCommonArrayFS
- Parameters:
srcOffset
- The index of the first element to copy.dest
- The array to copy to.destOffset
- Where to start copying intodest
.length
- The number of elements to copy.- Throws:
ArrayIndexOutOfBoundsException
- IfsrcOffset < 0
orlength > size()
ordestOffset + length > destArray.length
.
-
toStringArray
Description copied from interface:CommonArrayFS
Creates a new string array and copies this array values into it.- Specified by:
toStringArray
in interfaceCommonArrayFS
- Returns:
- A Java array copy of this array.
-