Package org.apache.uima.jcas.cas
Class FSArrayList<T extends TOP>
java.lang.Object
org.apache.uima.cas.impl.FeatureStructureImplC
org.apache.uima.jcas.cas.TOP
org.apache.uima.jcas.cas.FSArrayList<T>
- Type Parameters:
T- the generic type
- All Implemented Interfaces:
Cloneable,Iterable<T>,Collection<T>,List<T>,RandomAccess,CommonArrayFS<T>,FeatureStructure,FeatureStructureImpl,SelectViaCopyToArray<T>,UimaSerializable,UimaSerializableFSs
public class FSArrayList<T extends TOP>
extends TOP
implements UimaSerializableFSs, CommonArrayFS<T>, SelectViaCopyToArray<T>, List<T>, RandomAccess, Cloneable
An ArrayList type containing Feature Structures, for UIMA
- Has all the methods of List
- Implements the select(...) APIs
Implementation notes:
- Uses UimaSerializable APIs
- two implementations of the array list:
- one uses the original FSArray, via an asList wrapper
- This is used until an add or remove operation;
- switches to ArrayList, resetting the original FSArray to null
- This enables operation without creating the Java Object in use cases of deserializing and referencing when updating is not being used.
- The values stored internally are non-PEAR ones.
- The get/set/add operations convert to/from PEAR ones as needed
-
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 Stringstatic final intstatic final intFields 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
ConstructorsModifierConstructorDescriptionprotectedNever called.FSArrayList(TypeImpl type, CASImpl casImpl) Internal - constructor used by generatorFSArrayList(JCas jcas) FSArrayList(JCas jcas, int length) Make a new ArrayList with an initial size . -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidThis method is called by the framework before serialization of an instance of this JCas class.voidbooleanbooleanaddAll(int index, Collection<? extends T> c) booleanaddAll(Collection<? extends T> c) voidclear()booleanbooleancontainsAll(Collection<?> c) <E extends FeatureStructure>
voidcopyFromArray(E[] src, int srcPos, int destPos, int length) Copy from array.voidcopyFromArray(String[] src, int srcPos, int destPos, int length) Not supported, will throw UnsupportedOperationException.<E extends FeatureStructure>
voidcopyToArray(int srcPos, E[] dest, int destPos, int length) Copy to array.voidcopyToArray(int srcPos, String[] dest, int destPos, int length) Copies an array of Feature Structures to an Array of Strings.voidCopy values from another array of the same kindstatic <E extends TOP,F extends FeatureStructure>
FSArrayList<E>Convenience - create a FSArrayList from an existing Array.booleanA feature structure is equal to another feature structure iff it is identical in the underlying representation.voidget(int i) intinthashCode()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.intbooleanisEmpty()iterator()intlistIterator(int index) remove(int index) booleanbooleanremoveAll(Collection<?> c) booleanvoidreplaceAll(UnaryOperator<T> operator) booleanretainAll(Collection<?> c) updates the i-th value of the FSArrayList.intsize()return the size of the array.voidsort(Comparator<? super T> c) stream()subList(int fromIndex, int toIndex) TOP[]toArray()returns TOP[] because can't make array of T Note: converts to pear trampolines.<U> U[]toArray(U[] a) toString()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, getAddress, getBooleanValue, getByteValue, getCAS, getCASImpl, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getLongValue, getLowLevelCas, getShortValue, getStringValue, getType, prettyPrint, prettyPrint, prettyPrint, prettyPrint, prettyPrint, prettyPrint, prettyPrintShort, removeFromIndexes, removeFromIndexes, removeFromIndexes, setBooleanValue, setByteValue, setDoubleValue, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toShortString, toString, wrapGetIntCatchExceptionMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Collection
toArrayMethods inherited from interface org.apache.uima.cas.CommonArrayFS
getValuesAsCommaSeparatedString, toStringArrayMethods inherited from interface org.apache.uima.cas.FeatureStructure
_getTypeCode, _id, clone, getAddress, getBooleanValue, getByteValue, getCAS, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getJCas, getLongValue, getShortValue, getStringValue, getType, setBooleanValue, setByteValue, setDoubleValue, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValueMethods inherited from interface org.apache.uima.jcas.cas.SelectViaCopyToArray
_getView, select, select, select, select, selectMethods inherited from interface org.apache.uima.UimaSerializable
_reset_cas_data, cloneMethods inherited from interface org.apache.uima.UimaSerializableFSs
_save_fsRefs_to_cas_data
-
Field Details
-
_TypeName
- See Also:
-
typeIndexID
public static final int typeIndexID -
type
public static final int type -
_FeatName_fsArray
- See Also:
-
-
Constructor Details
-
FSArrayList
protected FSArrayList()Never called. Disable default constructor -
FSArrayList
Internal - constructor used by generator- Parameters:
casImpl- the CAS this Feature Structure belongs totype- the type of this Feature Structure
-
FSArrayList
- Parameters:
jcas- JCas to which this Feature Structure belongs
-
FSArrayList
Make a new ArrayList with an initial size .- Parameters:
jcas- The JCaslength- initial size
-
-
Method Details
-
getTypeIndexID
public int getTypeIndexID()- Overrides:
getTypeIndexIDin classTOP- Returns:
- index of the type
-
_init_from_cas_data
public void _init_from_cas_data()- Specified by:
_init_from_cas_datain interfaceUimaSerializable
-
_save_to_cas_data
public void _save_to_cas_data()Description copied from interface:UimaSerializableThis method is called by the framework before serialization of an instance of this JCas class. The implementation should save whatever data is needed into Features of this JCas class that can be serialized by UIMA.- Specified by:
_save_to_cas_datain interfaceUimaSerializable
-
get
-
set
updates the i-th value of the FSArrayList. -
size
public int size()return the size of the array. -
copyFromArray
public <E extends FeatureStructure> void copyFromArray(E[] src, int srcPos, int destPos, int length) Copy from array.- Type Parameters:
E- the type of the source array being copied from- Parameters:
src- -srcPos- -destPos- -length- -- See Also:
-
copyToArray
Copy to array.- Type Parameters:
E- the type of the elements of the Array being copied into- Parameters:
srcPos- -dest- -destPos- -length- -- See Also:
-
toArray
returns TOP[] because can't make array of T Note: converts to pear trampolines. -
_toArrayForSelect
- Specified by:
_toArrayForSelectin interfaceSelectViaCopyToArray<T extends TOP>
-
copyFromArray
Not supported, will throw UnsupportedOperationException.- Specified by:
copyFromArrayin interfaceCommonArrayFS<T extends TOP>- Parameters:
src- the srcsrcPos- the src posdestPos- the dest poslength- the length
-
copyToArray
Copies an array of Feature Structures to an Array of Strings. The strings are the "toString()" representation of the feature structures. If in Pear context, the Pear form is used.- Specified by:
copyToArrayin interfaceCommonArrayFS<T extends TOP>- 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.
-
copyValuesFrom
Description copied from interface:CommonArrayFSCopy values from another array of the same kind- Specified by:
copyValuesFromin interfaceCommonArrayFS<T extends TOP>- Parameters:
v- the other array
-
create
Convenience - create a FSArrayList from an existing Array.- Type Parameters:
E- generic type of returned FSF- generic type of the elements of the array argument- Parameters:
jcas- -a- -- Returns:
- -
-
_superClone
- Specified by:
_superClonein interfaceUimaSerializable
-
containsAll
- Specified by:
containsAllin interfaceCollection<T extends TOP>- Specified by:
containsAllin interfaceList<T extends TOP>
-
isEmpty
public boolean isEmpty() -
contains
-
indexOf
-
lastIndexOf
- Specified by:
lastIndexOfin interfaceList<T extends TOP>
-
toArray
public <U> U[] toArray(U[] a) -
toString
- Overrides:
toStringin classFeatureStructureImplC
-
add
-
equals
Description copied from interface:FeatureStructureA feature structure is equal to another feature structure iff it is identical in the underlying representation.- Specified by:
equalsin interfaceCollection<T extends TOP>- Specified by:
equalsin interfaceFeatureStructure- Specified by:
equalsin interfaceList<T extends TOP>- Overrides:
equalsin classFeatureStructureImplC
-
add
-
remove
-
remove
-
hashCode
public int hashCode()Description copied from interface:FeatureStructureWill 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:
hashCodein interfaceCollection<T extends TOP>- Specified by:
hashCodein interfaceFeatureStructure- Specified by:
hashCodein interfaceList<T extends TOP>- Overrides:
hashCodein classFeatureStructureImplC- Returns:
- The hash code.
-
clear
public void clear() -
addAll
-
addAll
-
removeAll
-
retainAll
-
stream
- Specified by:
streamin interfaceCollection<T extends TOP>
-
parallelStream
- Specified by:
parallelStreamin interfaceCollection<T extends TOP>
-
listIterator
- Specified by:
listIteratorin interfaceList<T extends TOP>
-
listIterator
- Specified by:
listIteratorin interfaceList<T extends TOP>
-
iterator
-
subList
-
forEach
-
spliterator
- Specified by:
spliteratorin interfaceCollection<T extends TOP>- Specified by:
spliteratorin interfaceIterable<T extends TOP>- Specified by:
spliteratorin interfaceList<T extends TOP>
-
removeIf
- Specified by:
removeIfin interfaceCollection<T extends TOP>
-
replaceAll
- Specified by:
replaceAllin interfaceList<T extends TOP>
-
sort
-