Class TOP

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

        public TOP_Type jcasType
        used to reference the corresponding TOP_Type instance
      • addr

        protected final int addr
        used to reference the corresponding Cas instance
    • Constructor Detail

      • TOP

        protected TOP()
      • TOP

        public TOP​(int addr,
                   TOP_Type jcasType)
      • TOP

        public TOP​(JCas jcas)
    • Method Detail

      • getTypeIndexID

        public int getTypeIndexID()
        used to obtain reference to the TOP_Type instance
        Returns:
        the type array index
      • addToIndexes

        public void addToIndexes()
        add the corresponding FeatureStructure to all Cas indexes in the view where this FS was created
      • addToIndexes

        public void addToIndexes​(JCas jcas)
        add this FS to indexes in a specific view, perhaps different from the creation view
        Parameters:
        jcas - the JCas
      • removeFromIndexes

        public void removeFromIndexes()
        remove the corresponding FeatureStructure from all Cas indexes in the view where this FS was created
      • removeFromIndexes

        public void removeFromIndexes​(JCas jcas)
        remove this FS from indexes in a specific view, perhaps different from the view where this was created.
        Parameters:
        jcas - the JCas
      • getCAS

        public CAS getCAS()
        Description copied from interface: FeatureStructure
        Return the CAS that this FS belongs to.
        Returns:
        the CAS view where this FS was created
      • equals

        public boolean equals​(java.lang.Object o)
        Description copied from interface: FeatureStructure
        A feature structure is equal to another feature structure iff it is identical in the underlying representation.
        Specified by:
        equals in interface FeatureStructure
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Description copied from interface: FeatureStructure
        Will return a hash code that's consistent with equality, i.e., if two FSs are equal, they will also return the same hash code.
        Specified by:
        hashCode in interface FeatureStructure
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        The hash code.