org.apache.uima.jcas.cas
Class BooleanArray

java.lang.Object
  extended by org.apache.uima.cas.impl.FeatureStructureImpl
      extended by org.apache.uima.jcas.cas.TOP
          extended by org.apache.uima.jcas.cas.BooleanArray
All Implemented Interfaces:
Cloneable, BooleanArrayFS, CommonArrayFS, FeatureStructure

public final class BooleanArray
extends TOP
implements BooleanArrayFS

JCas class model for BooleanArray


Field Summary
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
BooleanArray(int addr, TOP_Type type)
          Internal - Constructor used by generator
BooleanArray(JCas jcas, int length)
          Make a new BooleanArray of given size
 
Method Summary
 void copyFromArray(boolean[] src, int srcOffset, int destOffset, int length)
          Copy the contents of an external array into this array.
 void copyFromArray(String[] src, int srcOffset, int destOffset, int length)
          Copy the contents of an external string array into this array.
 void copyToArray(int srcOffset, boolean[] 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, String[] dest, int destOffset, int length)
          Copy the contents of the array to an external string array.
 boolean get(int i)
          Get the i-th string from the array.
 int getTypeIndexID()
          used to obtain reference to the _Type instance
 void set(int i, boolean v)
          Set the i-th value.
 int size()
          return the size of the array
 boolean[] toArray()
          Create a Java array that is a copy of the internal CAS array.
 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, 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
 

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

BooleanArray

public BooleanArray(int addr,
                    TOP_Type type)
Internal - Constructor used by generator


BooleanArray

public BooleanArray(JCas jcas,
                    int length)
Make a new BooleanArray of given size

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 boolean get(int i)
Description copied from interface: BooleanArrayFS
Get the i-th string from the array.

Specified by:
get in interface BooleanArrayFS
Returns:
The i-th element.
See Also:
BooleanArrayFS.get(int)

set

public void set(int i,
                boolean v)
Description copied from interface: BooleanArrayFS
Set the i-th value.

Specified by:
set in interface BooleanArrayFS
Parameters:
i - The index.
v - The value.
See Also:
BooleanArrayFS.set(int , boolean)

copyFromArray

public void copyFromArray(boolean[] src,
                          int srcOffset,
                          int destOffset,
                          int length)
Description copied from interface: BooleanArrayFS
Copy the contents of an external array into this array.

Specified by:
copyFromArray in interface BooleanArrayFS
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:
BooleanArrayFS.copyFromArray(boolean[], int, int, int)

copyToArray

public void copyToArray(int srcOffset,
                        boolean[] dest,
                        int destOffset,
                        int length)
Description copied from interface: BooleanArrayFS
Copy the contents of the array from start to end to the destination destArray with destination offset destOffset.

Specified by:
copyToArray in interface BooleanArrayFS
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:
BooleanArrayFS.copyToArray(int, boolean[], int, int)

toArray

public boolean[] toArray()
Description copied from interface: BooleanArrayFS
Create a Java array that is a copy of the internal CAS array.

Specified by:
toArray in interface BooleanArrayFS
Returns:
An array copy.
See Also:
BooleanArrayFS.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,
                        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(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 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.


Copyright © 2006-2010 The Apache Software Foundation. All Rights Reserved.