Package org.apache.uima.jcas.cas
Class StringArray
java.lang.Object
org.apache.uima.cas.impl.FeatureStructureImplC
org.apache.uima.jcas.cas.TOP
org.apache.uima.jcas.cas.StringArray
- All Implemented Interfaces:
Cloneable,Iterable<String>,CommonArrayFS<String>,FeatureStructure,FeatureStructureImpl,StringArrayFSImpl,StringArrayFS,CommonPrimitiveArray<String>
public final class StringArray
extends TOP
implements Iterable<String>, CommonPrimitiveArray<String>, StringArrayFSImpl
JCas class model for StringArray
-
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
ConstructorsConstructorDescriptionStringArray(TypeImpl t, CASImpl c, int length) used by generator Make a new StringArray of given sizeStringArray(JCas jcas, int length) Make a new StringArray of given size -
Method Summary
Modifier and TypeMethodDescriptionString[]booleanvoidcopyFromArray(String[] src, int srcPos, int destPos, int length) Copy the contents of an external string array into this array.voidcopyToArray(int srcPos, String[] dest, int destPos, int length) Copy the contents of the array to an external string array.voidCopy values from another array of the same kindstatic StringArrayget(int i) Get the i-th string from the array.intused to obtain reference to the TOP_Type instanceiterator()voidSet the i-th value.voidsetArrayValueFromString(int i, String v) Internal Use Only.intsize()return the size of the arraystream()String[]toArray()Creates a new array the this array is copied to.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, setStringValueMethods inherited from interface java.lang.Iterable
forEach, spliterator
-
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
-
StringArray
Make a new StringArray of given size- Parameters:
jcas- The JCaslength- The number of elements in the new array
-
StringArray
used by generator Make a new StringArray of given size- Parameters:
c- -t- -length- the length of the array in bytes
-
-
Method Details
-
getTypeIndexID
public int getTypeIndexID()used to obtain reference to the TOP_Type instance- Overrides:
getTypeIndexIDin classTOP- Returns:
- the type array index
-
get
Description copied from interface:StringArrayFSGet the i-th string from the array.- Specified by:
getin interfaceStringArrayFS- Parameters:
i- the index- Returns:
- The i-th element.
- See Also:
-
set
Description copied from interface:StringArrayFSSet the i-th value.- Specified by:
setin interfaceStringArrayFS- Parameters:
i- The index.v- The value.- See Also:
-
copyFromArray
Description copied from interface:CommonArrayFSCopy the contents of an external string array into this array. The strings are parsed and converted to floats.- Specified by:
copyFromArrayin interfaceCommonArrayFS<String>- 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:CommonArrayFSCopy the contents of the array to an external string array.- Specified by:
copyToArrayin interfaceCommonArrayFS<String>- 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:StringArrayFSCreates a new array the this array is copied to.- Specified by:
toArrayin interfaceStringArrayFS- Returns:
- A Java array copy of this FS array.
- See Also:
-
size
public int size()return the size of the array- Specified by:
sizein interfaceCommonArrayFS<String>- Returns:
- The size of the array.
-
_getTheArray
-
copyValuesFrom
Description copied from interface:CommonArrayFSCopy values from another array of the same kind- Specified by:
copyValuesFromin interfaceCommonArrayFS<String>- Parameters:
v- the other array
-
setArrayValueFromString
Description copied from interface:CommonPrimitiveArrayInternal Use Only. Set an array value from a string representation NOTE: does **not** log the change for delta cas; this should only be used by internal deserializers- Specified by:
setArrayValueFromStringin interfaceCommonPrimitiveArray<String>- Parameters:
i- the indexv- the value to set at the above index
-
iterator
-
create
- Parameters:
jcas- Which CAS to create the array ina- the source for the array's initial values- Returns:
- a newly created and populated array
-
contains
- Parameters:
v- the compare object- Returns:
- true if v is equal to one (or more) of the array elements
-
stream
-