Package org.apache.uima.jcas.cas
Class StringArray
java.lang.Object
org.apache.uima.cas.impl.FeatureStructureImpl
org.apache.uima.jcas.cas.TOP
org.apache.uima.jcas.cas.StringArray
- All Implemented Interfaces:
Cloneable
,Iterable<String>
,CommonArrayFS
,FeatureStructure
,StringArrayFS
JCas class model for StringArray
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
Each cover class when loaded sets an index. -
Constructor Summary
ConstructorsConstructorDescriptionStringArray
(int addr, TOP_Type type) StringArray
(JCas jcas, int length) Make a new StringArray of given size -
Method Summary
Modifier and TypeMethodDescriptionvoid
copyFromArray
(String[] 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) Copy the contents of the array fromstart
toend
to the destinationdestArray
with destination offsetdestOffset
.get
(int i) Get the i-th string from the array.int
used to obtain reference to the TOP_Type instanceiterator()
void
Set the i-th value.int
size()
return the size of the arrayString[]
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
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
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
-
StringArray
-
StringArray
Make a new StringArray 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 TOP_Type instance- Overrides:
getTypeIndexID
in classTOP
- Returns:
- the type array index
-
get
Description copied from interface:StringArrayFS
Get the i-th string from the array.- Specified by:
get
in interfaceStringArrayFS
- Parameters:
i
- the index- Returns:
- The i-th element.
- See Also:
-
set
Description copied from interface:StringArrayFS
Set the i-th value.- Specified by:
set
in interfaceStringArrayFS
- Parameters:
i
- The index.v
- The value.- See Also:
-
copyFromArray
Description copied from interface:StringArrayFS
Copy the contents of an external array into this array.- Specified by:
copyFromArray
in interfaceCommonArrayFS
- Specified by:
copyFromArray
in interfaceStringArrayFS
- 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:StringArrayFS
Copy the contents of the array fromstart
toend
to the destinationdestArray
with destination offsetdestOffset
.- Specified by:
copyToArray
in interfaceCommonArrayFS
- Specified by:
copyToArray
in interfaceStringArrayFS
- 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:StringArrayFS
Creates a new array the this array is copied to.- Specified by:
toArray
in interfaceStringArrayFS
- Returns:
- A Java array copy of this FS array.
- See Also:
-
size
public int size()return the size of the array- Specified by:
size
in interfaceCommonArrayFS
- Specified by:
size
in interfaceStringArrayFS
- Returns:
- The size of the array.
-
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.
-
iterator
-