Class StringArray

    • 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

      • StringArray

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

        public StringArray​(JCas jcas,
                           int length)
        Make a new StringArray 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 TOP_Type instance
        Overrides:
        getTypeIndexID in class TOP
        Returns:
        the type array index
      • get

        public java.lang.String get​(int i)
        Description copied from interface: StringArrayFS
        Get the i-th string from the array.
        Specified by:
        get in interface StringArrayFS
        Parameters:
        i - the index
        Returns:
        The i-th element.
        See Also:
        StringArrayFS.get(int)
      • copyFromArray

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

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

        public int size()
        return the size of the array
        Specified by:
        size in interface CommonArrayFS
        Specified by:
        size in interface StringArrayFS
        Returns:
        The size of the array.
      • 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.
      • iterator

        public java.util.Iterator<java.lang.String> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<java.lang.String>