Package org.apache.uima.jcas.cas
Class FSArray<T extends FeatureStructure>
java.lang.Object
org.apache.uima.cas.impl.FeatureStructureImplC
org.apache.uima.jcas.cas.TOP
org.apache.uima.jcas.cas.FSArray<T>
- All Implemented Interfaces:
Cloneable,Iterable<T>,ArrayFS<T>,CommonArrayFS<T>,FeatureStructure,FeatureStructureImpl,ArrayFSImpl<T>,SelectViaCopyToArray<T>
public final class FSArray<T extends FeatureStructure>
extends TOP
implements ArrayFSImpl<T>, Iterable<T>, SelectViaCopyToArray<T>
Java Class model for Cas FSArray type extends FeatureStructure for backwards compatibility when
using FSArray with no typing.
-
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 intstatic final inteach cover class when loaded sets an index.Fields 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
ConstructorsConstructorDescriptionConstructs an instance of a subtype of FSArray having the component type clazz Note: the array with this component type must already be specified in the type system declaration as a feature whose range is FSArray with the specified elementType.used by generator Make a new FSArray of given sizeMake a new FSArray of given size -
Method Summary
Modifier and TypeMethodDescriptionTOP[]booleanvoidcopyFromArray(String[] src, int srcPos, int destPos, int length) Not supported, will throw UnsupportedOperationException<U extends FeatureStructure>
voidcopyFromArray(U[] src, int srcPos, int destPos, int length) Copy the contents of an external array into this array.voidcopyToArray(int srcPos, String[] dest, int destPos, int length) Copies an array of Feature Structures to an Array of Strings.<U extends FeatureStructure>
voidcopyToArray(int srcPos, U[] dest, int destPos, int length) Copy the contents of the array fromstarttoendto the destinationdestArraywith destination offsetdestOffset.voidCopy values from another array of the same kindstatic <U extends FeatureStructure>
FSArray<U>create(JCas jcas, FeatureStructure[] a) Convenience - create a FSArray from an existing FeatureStructure[]<U extends FeatureStructure>
Uget(int i) return the indexed value from the corresponding Cas FSArray as a Java Model object.intused to obtain reference to the _Type instanceiterator()voidupdates the Cas, setting the indexed value with the corresponding Cas FeatureStructure.intsize()return the size of the array.stream()toArray()Creates a new array the this array is copied to.<U extends TOP>
U[]toArray(U[] a) Populates an existing array from this FS Array.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, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toShortString, toString, toString, wrapGetIntCatchExceptionMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.uima.cas.CommonArrayFS
getValuesAsCommaSeparatedString, isEmpty, toStringArrayMethods 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, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue
-
Field Details
-
_TypeName
- See Also:
-
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
Make a new FSArray of given size- Parameters:
jcas- The JCaslength- The number of elements in the new array
-
FSArray
used by generator Make a new FSArray of given size- Parameters:
c- -t- -length- the length of the array
-
FSArray
Constructs an instance of a subtype of FSArray having the component type clazz Note: the array with this component type must already be specified in the type system declaration as a feature whose range is FSArray with the specified elementType.- Parameters:
clazz- - the FSArray's element's classjcas- -length- -
-
-
Method Details
-
getTypeIndexID
public int getTypeIndexID()used to obtain reference to the _Type instance- Overrides:
getTypeIndexIDin classTOP- Returns:
- the type array index
-
get
return the indexed value from the corresponding Cas FSArray as a Java Model object.- Specified by:
getin interfaceArrayFS<T extends FeatureStructure>- Type Parameters:
U- The class of the item being obtained by the get- Parameters:
i- index- Returns:
- The i-th feature structure.
-
set
updates the Cas, setting the indexed value with the corresponding Cas FeatureStructure.- Specified by:
setin interfaceArrayFS<T extends FeatureStructure>- Parameters:
i- The index.av- The value.
-
size
public int size()return the size of the array.- Specified by:
sizein interfaceCommonArrayFS<T extends FeatureStructure>- Returns:
- The size of the array.
-
copyFromArray
public <U extends FeatureStructure> void copyFromArray(U[] src, int srcPos, int destPos, int length) Description copied from interface:ArrayFSCopy the contents of an external array into this array.- Specified by:
copyFromArrayin interfaceArrayFS<T extends FeatureStructure>- Type Parameters:
U- the class of the array being copied into- Parameters:
src- The source array.srcPos- Where to start copying in the source array.destPos- Where to start copying to in the destination array.length- The number of elements to copy.- See Also:
-
copyToArray
Description copied from interface:ArrayFSCopy the contents of the array fromstarttoendto the destinationdestArraywith destination offsetdestOffset.- Specified by:
copyToArrayin interfaceArrayFS<T extends FeatureStructure>- Type Parameters:
U- the type of the array element- Parameters:
srcPos- The index of the first element to copy.dest- The array to copy to.destPos- Where to start copying intodest.length- The number of elements to copy.- See Also:
-
toArray
Description copied from interface:ArrayFSCreates a new array the this array is copied to. Return type is FeatureStructure to be backwards compatible with V2- Specified by:
toArrayin interfaceArrayFS<T extends FeatureStructure>- Returns:
- A Java array copy of this FS array.
- See Also:
-
_toArrayForSelect
- Specified by:
_toArrayForSelectin interfaceSelectViaCopyToArray<T extends FeatureStructure>
-
copyFromArray
Not supported, will throw UnsupportedOperationException- Specified by:
copyFromArrayin interfaceCommonArrayFS<T extends FeatureStructure>- Parameters:
src- The source array.srcPos- Where to start copying in the source array.destPos- 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,- Specified by:
copyToArrayin interfaceCommonArrayFS<T extends FeatureStructure>- Parameters:
srcPos- The index of the first element to copy.dest- The array to copy to.destPos- Where to start copying intodest.length- The number of elements to copy.- Throws:
ArrayIndexOutOfBoundsException- IfsrcPos < 0orlength > size()ordestPos + length > destArray.length.
-
_getTheArray
-
copyValuesFrom
Description copied from interface:CommonArrayFSCopy values from another array of the same kind- Specified by:
copyValuesFromin interfaceCommonArrayFS<T extends FeatureStructure>- Parameters:
v- the other array
-
create
Convenience - create a FSArray from an existing FeatureStructure[]- Type Parameters:
U- the element type of the FSArray, subtype of FeatureStructure- Parameters:
jcas- -a- -- Returns:
- -
-
iterator
- Specified by:
iteratorin interfaceIterable<T extends FeatureStructure>
-
spliterator
- Specified by:
spliteratorin interfaceIterable<T extends FeatureStructure>
-
stream
-
contains
-
toArray
Description copied from interface:ArrayFSPopulates an existing array from this FS Array.- Specified by:
toArrayin interfaceArrayFS<T extends FeatureStructure>- Type Parameters:
U- the type of the element- Parameters:
a- the existing array- Returns:
- the populated array
-