Package org.apache.uima.cas

Interface CommonArrayFS

All Superinterfaces:

FeatureStructure

All Known Subinterfaces:

ArrayFS, BooleanArrayFS, ByteArrayFS, DoubleArrayFS, FloatArrayFS, IntArrayFS, LongArrayFS, ShortArrayFS, StringArrayFS

All Known Implementing Classes:

ArrayFSImpl, BooleanArray, BooleanArrayFSImpl, ByteArray, ByteArrayFSImpl, DoubleArray, DoubleArrayFSImpl, FloatArray, FloatArrayFSImpl, FSArray, IntArrayFSImpl, IntegerArray, LongArray, LongArrayFSImpl, ShortArray, ShortArrayFSImpl, StringArray, StringArrayFSImpl

public interface CommonArrayFS
extends FeatureStructure

Common parts of the Array interfaces.

Method Summary

Modifier and Type	Method	Description
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, java.lang.String[] dest, int destOffset, int length)	Copy the contents of the array to an external string array.
int	size()	Return the size of the array.
java.lang.String[]	toStringArray()	Creates a new string array and copies this array values into it.

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

Method Detail

size

int size()

Return the size of the array.

Returns:

The size of the array.

toStringArray

java.lang.String[] toStringArray()

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

Returns:

A Java array copy of this array.

copyToArray

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

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

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.

Throws:

java.lang.ArrayIndexOutOfBoundsException - If srcOffset < 0 or length > size() or destOffset + length > destArray.length.

copyFromArray

void copyFromArray(java.lang.String[] src,
                   int srcOffset,
                   int destOffset,
                   int length)
            throws java.lang.ArrayIndexOutOfBoundsException,
                   java.lang.NumberFormatException

Copy the contents of an external string array into this array. The strings are parsed and converted to floats.

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.

Throws:

java.lang.ArrayIndexOutOfBoundsException - When length conditions are not met.

java.lang.NumberFormatException - When the input strings do not represent valid floats.

java.lang.UnsupportedOperationException - When the array is an array of FSs.