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:

Cloneable, Iterable<Byte>, ByteArrayFS, CommonArrayFS<Byte>, FeatureStructure, org.apache.uima.cas.impl.ByteArrayFSImpl, org.apache.uima.cas.impl.FeatureStructureImpl, CommonPrimitiveArray<Byte>

public final class ByteArray
extends TOP
implements CommonPrimitiveArray<Byte>, org.apache.uima.cas.impl.ByteArrayFSImpl, Iterable<Byte>

JCas class model for ByteArray

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.uima.cas.impl.FeatureStructureImplC

org.apache.uima.cas.impl.FeatureStructureImplC.PrintReferences

Field Summary

Fields

Modifier and Type	Field and Description
static String	_TypeName
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

Constructor Summary

Constructors

Constructor and Description
ByteArray(JCas jcas, int length) Make a new ByteArray of given size
ByteArray(org.apache.uima.cas.impl.TypeImpl t, org.apache.uima.cas.impl.CASImpl c, int length) used by generator Make a new ByteArray of given size

Method Summary

Modifier and Type	Method and 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(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 from start to end to the destination destArray with destination offset destOffset.
void	copyToArray(int srcPos, String[] dest, int destPos, int length) Copy the contents of the array to an external string array.
void	copyValuesFrom(CommonArrayFS<Byte> v) Copy values from another array of the same kind
static 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 instance
Iterator<Byte>	iterator()
void	set(int i, byte v) Set the i-th value.
void	setArrayValueFromString(int i, String v) Internal Use Only.
int	size() return the size of the array
byte[]	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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

_TypeName

public static final 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

Constructor Detail

ByteArray

public ByteArray(JCas jcas,
                 int length)

Make a new ByteArray of given size

Parameters:

jcas - the JCas

length - the length of the array in bytes

ByteArray

public ByteArray(org.apache.uima.cas.impl.TypeImpl t,
                 org.apache.uima.cas.impl.CASImpl c,
                 int length)

used by generator Make a new ByteArray of given size

Parameters:

c - -

t - -

length - the length of the array in bytes

Method Detail

getTypeIndexID

public int getTypeIndexID()

used to obtain reference to the _Type instance

Overrides:

getTypeIndexID in class TOP

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 interface ByteArrayFS

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 interface ByteArrayFS

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 interface ByteArrayFS

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 from start to end to the destination destArray with destination offset destOffset.

Specified by:

copyToArray in interface ByteArrayFS

Parameters:

srcPos - The index of the first element to copy.

dest - The array to copy to.

destPos - Where to start copying into dest.

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 interface ByteArrayFS

Returns:

An array copy.

See Also:

ByteArrayFS.toArray()

size

public int size()

return the size of the array

Specified by:

size in interface CommonArrayFS<Byte>

Returns:

The size of the array.

copyToArray

public void copyToArray(int srcPos,
                        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 interface CommonArrayFS<Byte>

Parameters:

srcPos - The index of the first element to copy.

dest - The array to copy to.

destPos - Where to start copying into dest.

length - The number of elements to copy.

See Also:

CommonArrayFS.copyToArray(int, String[], int, int)

copyFromArray

public void copyFromArray(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 interface CommonArrayFS<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<Byte> v)

Description copied from interface: CommonArrayFS

Copy values from another array of the same kind

Specified by:

copyValuesFrom in interface CommonArrayFS<Byte>

Parameters:

v - the other array

setArrayValueFromString

public void setArrayValueFromString(int i,
                                    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 interface CommonPrimitiveArray<Byte>

Parameters:

i - the index

v - the value to set at the above index

iterator

public Iterator<Byte> iterator()

Specified by:

iterator in interface Iterable<Byte>

create

public static ByteArray create(JCas jcas,
                               byte[] a)

Parameters:

jcas - Which CAS to create the array in

a - 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