org.apache.uima.search

## Interface IndexRule

- All Superinterfaces:
    Serializable, XMLizable
  All Known Implementing Classes:
    IndexRule_impl

      public interface IndexRule
      extends XMLizable, Serializable

  A rule that specifies indexing behavior. An indexing rule is attached to an `IndexBuildItem` in order to assign indexing behavior to an annotation type. An Index Rule consists of zero or more `Style`s.

  This object implements the `XMLizable` interface and can be parsed from an XML representation.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `Style[]` | `getStyles()` Gets the styles that comprise this index rule.
    `void` | `setStyles(Style[] aStyles)` Sets the styles that comprise this index rule.

    - ### Methods inherited from interface org.apache.uima.util.XMLizable

      `buildFromXMLElement, buildFromXMLElement, toXML, toXML, toXML, toXML`

- - ### Method Detail

    - #### getStyles

          Style[] getStyles()

      Gets the styles that comprise this index rule.
      Returns:
        the CAS type name for this build item

    - #### setStyles

          void setStyles(Style[] aStyles)

      Sets the styles that comprise this index rule.
      Parameters:
        `aStyles` - the CAS type name for this build item

Copyright © 2006–2022 The Apache Software Foundation. All rights reserved.