Package org.apache.uima.jcas.cas
Class ByteArray
- java.lang.Object
-
- org.apache.uima.cas.impl.FeatureStructureImplC
-
- org.apache.uima.jcas.cas.TOP
-
- org.apache.uima.jcas.cas.ByteArray
-
- All Implemented Interfaces:
java.lang.Cloneable
,java.lang.Iterable<java.lang.Byte>
,ByteArrayFS
,CommonArrayFS<java.lang.Byte>
,FeatureStructure
,ByteArrayFSImpl
,FeatureStructureImpl
,CommonPrimitiveArray<java.lang.Byte>
public final class ByteArray extends TOP implements CommonPrimitiveArray<java.lang.Byte>, ByteArrayFSImpl, java.lang.Iterable<java.lang.Byte>
JCas class model for ByteArray
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.uima.cas.impl.FeatureStructureImplC
FeatureStructureImplC.PrintReferences
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
_TypeName
private byte[]
theArray
static int
type
static int
typeIndexID
Each cover class when loaded sets an index.-
Fields inherited from class org.apache.uima.jcas.cas.TOP
_singleton
-
Fields 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
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description byte[]
_getTheArray()
boolean
contains(byte item)
void
copyFromArray(byte[] src, int srcPos, int destPos, int length)
Copy the contents of an external array into this array.void
copyFromArray(java.lang.String[] src, int srcPos, int destPos, int length)
Copy the contents of an external string array into this array.void
copyToArray(int srcPos, byte[] dest, int destPos, int length)
Copy the contents of the array fromstart
toend
to the destinationdestArray
with destination offsetdestOffset
.void
copyToArray(int srcPos, java.lang.String[] dest, int destPos, int length)
Copy the contents of the array to an external string array.void
copyValuesFrom(CommonArrayFS<java.lang.Byte> v)
Copy values from another array of the same kindstatic ByteArray
create(JCas jcas, byte[] a)
byte
get(int i)
Get the i-th string from the array.int
getTypeIndexID()
used to obtain reference to the _Type instancejava.util.Iterator<java.lang.Byte>
iterator()
void
set(int i, byte v)
Set the i-th value.void
setArrayValueFromString(int i, java.lang.String v)
Internal Use Only.int
size()
return the size of the arraybyte[]
toArray()
Create a Java array that is a copy of the internal CAS array.-
Methods inherited from class org.apache.uima.jcas.cas.TOP
_createJCasHashMapReserve, _createSearchKey
-
Methods 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, wrapGetIntCatchException
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.uima.cas.CommonArrayFS
getValuesAsCommaSeparatedString, isEmpty, toStringArray
-
Methods 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 Detail
-
_TypeName
public static final java.lang.String _TypeName
- See Also:
- Constant Field Values
-
typeIndexID
public static final int typeIndexID
Each 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
-
theArray
private final byte[] theArray
-
-
Constructor Detail
-
ByteArray
private ByteArray()
-
ByteArray
public ByteArray(JCas jcas, int length)
Make a new ByteArray of given size- Parameters:
jcas
- the JCaslength
- the length of the array in bytes
-
-
Method Detail
-
getTypeIndexID
public int getTypeIndexID()
used to obtain reference to the _Type instance- Overrides:
getTypeIndexID
in classTOP
- Returns:
- the type array index
-
get
public byte get(int i)
Description copied from interface:ByteArrayFS
Get the i-th string from the array.- Specified by:
get
in interfaceByteArrayFS
- Parameters:
i
- the index- Returns:
- The i-th element.
- See Also:
ByteArrayFS.get(int)
-
set
public void set(int i, byte v)
Description copied from interface:ByteArrayFS
Set the i-th value.- Specified by:
set
in interfaceByteArrayFS
- Parameters:
i
- The index.v
- The value.- See Also:
ByteArrayFS.set(int , byte)
-
copyFromArray
public void copyFromArray(byte[] src, int srcPos, int destPos, int length)
Description copied from interface:ByteArrayFS
Copy the contents of an external array into this array.- Specified by:
copyFromArray
in interfaceByteArrayFS
- 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:
ByteArrayFS.copyFromArray(byte[], int, int, int)
-
copyToArray
public void copyToArray(int srcPos, byte[] dest, int destPos, int length)
Description copied from interface:ByteArrayFS
Copy the contents of the array fromstart
toend
to the destinationdestArray
with destination offsetdestOffset
.- Specified by:
copyToArray
in interfaceByteArrayFS
- 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:
ByteArrayFS.copyToArray(int, byte[], int, int)
-
toArray
public byte[] toArray()
Description copied from interface:ByteArrayFS
Create a Java array that is a copy of the internal CAS array.- Specified by:
toArray
in interfaceByteArrayFS
- Returns:
- An array copy.
- See Also:
ByteArrayFS.toArray()
-
size
public int size()
return the size of the array- Specified by:
size
in interfaceCommonArrayFS<java.lang.Byte>
- Returns:
- The size of the array.
-
copyToArray
public void copyToArray(int srcPos, java.lang.String[] dest, int destPos, int length)
Description copied from interface:CommonArrayFS
Copy the contents of the array to an external string array.- Specified by:
copyToArray
in interfaceCommonArrayFS<java.lang.Byte>
- 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:
CommonArrayFS.copyToArray(int, String[], int, int)
-
copyFromArray
public void copyFromArray(java.lang.String[] src, int srcPos, int destPos, int length)
Description copied from interface:CommonArrayFS
Copy the contents of an external string array into this array. The strings are parsed and converted to floats.- Specified by:
copyFromArray
in interfaceCommonArrayFS<java.lang.Byte>
- 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:
CommonArrayFS.copyFromArray(String[], int, int, int)
-
_getTheArray
public byte[] _getTheArray()
-
copyValuesFrom
public void copyValuesFrom(CommonArrayFS<java.lang.Byte> v)
Description copied from interface:CommonArrayFS
Copy values from another array of the same kind- Specified by:
copyValuesFrom
in interfaceCommonArrayFS<java.lang.Byte>
- Parameters:
v
- the other array
-
setArrayValueFromString
public void setArrayValueFromString(int i, java.lang.String v)
Description copied from interface:CommonPrimitiveArray
Internal 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:
setArrayValueFromString
in interfaceCommonPrimitiveArray<java.lang.Byte>
- Parameters:
i
- the indexv
- the value to set at the above index
-
iterator
public java.util.Iterator<java.lang.Byte> iterator()
- Specified by:
iterator
in interfacejava.lang.Iterable<java.lang.Byte>
-
create
public static ByteArray create(JCas jcas, byte[] a)
- 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
public boolean contains(byte item)
- Parameters:
item
- the item to see if is in the array- Returns:
- true if the item is in the array
-
-