Package org.apache.uima.jcas.cas

Class ByteArray

java.lang.Object

org.apache.uima.cas.impl.FeatureStructureImpl

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, FeatureStructure

public final class ByteArray
extends TOP
implements ByteArrayFS, java.lang.Iterable<java.lang.Byte>

JCas class model for ByteArray

Field Summary

Fields

Modifier and Type	Field	Description
static int	type
static int	typeIndexID	Each cover class when loaded sets an index.

Fields inherited from class org.apache.uima.jcas.cas.TOP

addr, jcasType

Constructor Summary

Constructors

Constructor	Description
ByteArray(int addr, TOP_Type type)
ByteArray(JCas jcas, int length)	Make a new ByteArray of given size

Method Summary

Modifier and Type	Method	Description
void	copyFromArray(byte[] src, int srcOffset, int destOffset, int length)	Copy the contents of an external array into this array.
void	copyFromArray(java.lang.String[] src, int srcOffset, int destOffset, int length)	Copy the contents of an external string array into this array.
void	copyToArray(int srcOffset, byte[] dest, int destOffset, int length)	Copy the contents of the array from start to end to the destination destArray with destination offset destOffset.
void	copyToArray(int srcOffset, java.lang.String[] dest, int destOffset, int length)	Copy the contents of the array to an external string array.
byte	get(int i)	Get the i-th string from the array.
int	getTypeIndexID()	used to obtain reference to the _Type instance
java.util.Iterator<java.lang.Byte>	iterator()
void	set(int i, byte v)	Set the i-th value.
int	size()	return the size of the array
byte[]	toArray()	Create a Java array that is a copy of the internal CAS array.
java.lang.String[]	toStringArray()	Creates a new string array and copies this array values into it.

Methods inherited from class org.apache.uima.jcas.cas.TOP

addToIndexes, addToIndexes, equals, getAddress, getCAS, getCASImpl, getLowLevelCas, hashCode, removeFromIndexes, removeFromIndexes

Methods inherited from class org.apache.uima.cas.impl.FeatureStructureImpl

clone, getavoidcollisionTypeCode, getBooleanValue, getByteValue, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, getLongValue, getShortValue, getStringValue, getType, prettyPrint, prettyPrint, prettyPrint, setBooleanValue, setByteValue, setDoubleValue, setFeatureValue, setFeatureValueFromString, setFloatValue, setIntValue, setLongValue, setShortValue, setStringValue, toString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.uima.cas.FeatureStructure

clone, equals, getBooleanValue, getByteValue, getCAS, getDoubleValue, getFeatureValue, getFeatureValueAsString, getFloatValue, getIntValue, 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

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(int addr,
                 TOP_Type type)

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

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 srcOffset,
                          int destOffset,
                          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.

srcOffset - Where to start copying in the source array.

destOffset - 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 srcOffset,
                        byte[] dest,
                        int destOffset,
                        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:

srcOffset - The index of the first element to copy.

dest - The array to copy to.

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

Returns:

The size of the array.

copyToArray

public void copyToArray(int srcOffset,
                        java.lang.String[] dest,
                        int destOffset,
                        int length)

Description copied from interface: CommonArrayFS

Copy the contents of the array to an external string array.

Specified by:

copyToArray in interface CommonArrayFS

Parameters:

srcOffset - The index of the first element to copy.

dest - The array to copy to.

destOffset - 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(java.lang.String[] src,
                          int srcOffset,
                          int destOffset,
                          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

Parameters:

src - The source array.

srcOffset - Where to start copying in the source array.

destOffset - Where to start copying to in the destination array.

length - The number of elements to copy.

See Also:

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

toStringArray

public java.lang.String[] toStringArray()

Description copied from interface: CommonArrayFS

Creates a new string array and copies this array values into it.

Specified by:

toStringArray in interface CommonArrayFS

Returns:

A Java array copy of this array.

iterator

public java.util.Iterator<java.lang.Byte> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.lang.Byte>