Interface FsIndexDescription

    • Method Detail

      • getLabel

        String getLabel()
        Gets the label of this index. This is the identifier used to retrieve the index from the CAS's Index Repository.
        Returns:
        the label of this index.
      • setLabel

        void setLabel​(String aLabel)
        Sets the label of this index. This is the identifier used to retrieve the index from the CAS's Index Repository.
        Parameters:
        aLabel - the label of this index.
      • getTypeName

        String getTypeName()
        Gets the Type name for this index. This determines what type of FeatureStructures are contained in the index.
        Returns:
        the type name for this index
      • setTypeName

        void setTypeName​(String aTypeName)
        Sets the Type name for this index. This determines what type of FeatureStructures are contained in the index.
        Parameters:
        aTypeName - the type name for this index
      • getKind

        String getKind()
        Gets the "kind" of index. There are currently three kinds of indexes - "sorted", "set", and "bag" (see FSIndex for definitions). If this is null, "sorted" is assumed as the default.
        Returns:
        the kind of index
      • setKind

        void setKind​(String aKind)
        Sets the "kind" of index. There are currently three kinds of indexes - sorted, set, and bag (see FSIndex for definitions). If this is null, "sorted" is assumed as the default.
        Parameters:
        aKind - the kind of index
      • getKeys

        FsIndexKeyDescription[] getKeys()
        Gets the keys for this index. The keys determine the ordering of FeatureStructures in this index.
        Returns:
        the keys for this index
      • setKeys

        void setKeys​(FsIndexKeyDescription[] aKeys)
        Sets the keys for this index. The keys determine the ordering of FeatureStructures in this index.
        Parameters:
        aKeys - the keys for this index