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:
Cloneable, Iterable<Byte>, ByteArrayFS, CommonArrayFS, FeatureStructure
public final class ByteArray extends TOP implements ByteArrayFS, Iterable<Byte>
JCas class model for ByteArray

  • Field Details

    • 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 Details

    • 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 Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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.

    • iterator

      public Iterator<Byte> iterator()
      Specified by:
      iterator in interface Iterable<Byte>