Class TOP_Type

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

        public final Type casType
        the Cas Type associated with this Java Cas Model class
      • casTypeCode

        public final int casTypeCode
      • jcas

        public final JCas jcas
        reference to the Java Cas root
      • casImpl

        public final CASImpl casImpl
        ref to CAS for faster getters/setters
      • lowLevelTypeChecks

        protected final boolean lowLevelTypeChecks
      • lowLevelArrayBoundChecks

        protected final boolean lowLevelArrayBoundChecks
      • useExistingInstance

        public final boolean useExistingInstance
      • instanceOf_Type

        protected final TOP_Type instanceOf_Type
        This generator can be set up to either get the identical Java object (if it exists) or just make a new one. If making a new one - the java object made cannot contain any other data (because updates won't be reflected). Each class generated by JCasGen either does this (if it has additional java fields imbedded) or not.
    • Constructor Detail

      • TOP_Type

        protected TOP_Type()
        protected constructor - disable default constructor - never called.
      • TOP_Type

        public TOP_Type​(JCas jcas,
                        Type casType)
      • TOP_Type

        protected TOP_Type​(JCas jcas,
                           Type casType,
                           boolean installGenerator)
    • Method Detail

      • getTypeIndexID

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

        protected FSGenerator<?> getFSGenerator()
      • checkType

        protected void checkType​(int inst)
      • invalidTypeArg

        protected void invalidTypeArg​(int inst)
      • addToIndexes

        public void addToIndexes​(int inst)
        add the corresponding FeatureStructure to all Cas indexes
        Parameters:
        inst - the low level CAS Feature Structure reference
      • removeFromIndexes

        public void removeFromIndexes​(int inst)
        remove the corresponding FeatureStructure from all Cas indexes
        Parameters:
        inst - the low level CAS Feature Structure reference
      • noObjCreate

        public int noObjCreate()