org.apache.uima.jcas.cas
Class FloatArray

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.FloatArray
All Implemented Interfaces:
Cloneable, CommonArrayFS, FeatureStructure, FloatArrayFS

public final class FloatArray
extends TOP
implements FloatArrayFS

Java Cas model for Cas FloatArray.


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
FloatArray(int addr, TOP_Type type)
          Internal - Constructor used by generator
FloatArray(JCas jcas, int length)
          Make a new FloatArray of given size
 
Method Summary
 void copyFromArray(float[] 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, float[] dest, int destOffset, int length)
          Copy the contents of the array to an external array.
 void copyToArray(int srcOffset, String[] dest, int destOffset, int length)
          Copy the contents of the array to an external string array.
 float get(int i)
          return the indexed value from the corresponding Cas FloatArray as a float,
 int getTypeIndexID()
          used to obtain reference to the _Type instance
 void set(int i, float v)
          update the Cas, setting the indexed value to the passed in Java float value.
 int size()
          return the size of the array
 float[] 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

FloatArray

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


FloatArray

public FloatArray(JCas jcas,
                  int length)
Make a new FloatArray 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 float get(int i)
return the indexed value from the corresponding Cas FloatArray as a float,

Specified by:
get in interface FloatArrayFS
Returns:
The element.

set

public void set(int i,
                float v)
update the Cas, setting the indexed value to the passed in Java float value.

Specified by:
set in interface FloatArrayFS
Parameters:
i - index
v - value to set

copyFromArray

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

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

copyToArray

public void copyToArray(int srcOffset,
                        float[] dest,
                        int destOffset,
                        int length)
Description copied from interface: FloatArrayFS
Copy the contents of the array to an external array.

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

toArray

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

Specified by:
toArray in interface FloatArrayFS
Returns:
An array copy.
See Also:
ArrayFS.toArray()

size

public int size()
return the size of the array

Specified by:
size in interface CommonArrayFS
Returns:
size of 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.
See Also:
CommonArrayFS.toStringArray()


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