Class FSArray

    • 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

      • FSArray

        public FSArray​(int addr,
                       TOP_Type type)
      • FSArray

        public FSArray​(JCas jcas,
                       int length)
        Make a new FSArray of given size
        Parameters:
        jcas - The JCas
        length - The number of elements in the new array
    • 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 FeatureStructure get​(int i)
        return the indexed value from the corresponding Cas FSArray as a Java Model object.
        Specified by:
        get in interface ArrayFS
        Parameters:
        i - index
        Returns:
        The i-th feature structure.
      • set

        public void set​(int i,
                        FeatureStructure v)
        updates the Cas, setting the indexed value with the corresponding Cas FeatureStructure.
        Specified by:
        set in interface ArrayFS
        Parameters:
        i - The index.
        v - The value.
      • size

        public int size()
        return the size of the array.
        Specified by:
        size in interface ArrayFS
        Specified by:
        size in interface CommonArrayFS
        Returns:
        The size of the array.
      • copyFromArray

        public void copyFromArray​(FeatureStructure[] src,
                                  int srcOffset,
                                  int destOffset,
                                  int length)
        Description copied from interface: ArrayFS
        Copy the contents of an external array into this array.
        Specified by:
        copyFromArray in interface ArrayFS
        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:
        ArrayFS.copyFromArray(FeatureStructure[], int, int, int)
      • copyToArray

        public void copyToArray​(int srcOffset,
                                FeatureStructure[] dest,
                                int destOffset,
                                int length)
        Description copied from interface: ArrayFS
        Copy the contents of the array from start to end to the destination destArray with destination offset destOffset.
        Specified by:
        copyToArray in interface ArrayFS
        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:
        ArrayFS.copyToArray(int, FeatureStructure[], int, int)
      • copyFromArray

        public void copyFromArray​(java.lang.String[] src,
                                  int srcOffset,
                                  int destOffset,
                                  int length)
        Not supported, will throw UnsupportedOperationException
        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.
      • copyToArray

        public void copyToArray​(int srcOffset,
                                java.lang.String[] dest,
                                int destOffset,
                                int length)
        Copies an array of Feature Structures to an Array of Strings. The strings are the "toString()" representation of the feature structures, which are probably something that looks like FeatureStructure@123456
        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.
        Throws:
        java.lang.ArrayIndexOutOfBoundsException - If srcOffset < 0 or length > size() or destOffset + length > destArray.length.
      • 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.