Package org.apache.uima.fit.descriptor

Annotation Interface FsIndex

@Retention(RUNTIME) @Target(TYPE) public @interface FsIndex
See Also:

  • Field Details

  • Element Details

    • label

      String label
      Returns:
      the label of this index
      See Also:
      • FsIndexDescription.getLabel()

    • typeName

      String typeName
      The type of the index as name. As an alternative, the index can be defined using a class with type(). One method or the other must be used to set the index type.
      Returns:
      the type name for this index
      See Also:
      • FsIndexDescription.getTypeName()
      Default:
      "org.apache.uima.fit.descriptor.FsIndex.NO_NAME_TYPE_SET"

    • type

      Class<? extends org.apache.uima.jcas.cas.TOP> type
      The type of the index as class. As an alternative, the index can be defined using a type name with typeName(). One method or the other must be used to set the index type.
      Returns:
      the type for this index
      See Also:
      • FsIndexDescription.getTypeName()
      Default:
      org.apache.uima.fit.descriptor.FsIndex.NoClassSet.class

    • kind

      String kind
      Returns:
      the kind of index
      See Also:
      • FsIndexDescription.getKind()
      Default:
      "bag"

    • keys

      FsIndexKey[] keys
      Returns:
      the keys for this index
      See Also:
      • FsIndexDescription.getKeys()
      Default:
      {}

    • typePriorities

      boolean typePriorities
      Returns:
      true if and only if this is a type priority key
      See Also:
      • FsIndexKeyDescription.isTypePriority()
      Default:
      true