org.modeshape.jcr.query

## Interface IndexRules.Rule

- All Known Subinterfaces:
    IndexRules.NumericRule<T>
  All Known Implementing Classes:
    IndexRules.NumericTypedRule, IndexRules.SkipRule, IndexRules.TypedRule
  Enclosing class:
    IndexRules

      @Immutable
      public static interface IndexRules.Rule

  A single rule that dictates how a single property should be indexed.
  See Also:
    `IndexRules.getRule(Name)`

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `canBeReference()`
    `org.apache.lucene.document.Field.Index` | `getIndexOption()`
    `org.apache.lucene.document.Field.Store` | `getStoreOption()`
    `IndexRules.FieldType` | `getType()`
    `boolean` | `isFullTextSearchable()`
    `boolean` | `isSkipped()`

- - ### Method Detail

    - #### isSkipped

          boolean isSkipped()

    - #### canBeReference

          boolean canBeReference()

    - #### isFullTextSearchable

          boolean isFullTextSearchable()

    - #### getType

          IndexRules.FieldType getType()

    - #### getStoreOption

          org.apache.lucene.document.Field.Store getStoreOption()

    - #### getIndexOption

          org.apache.lucene.document.Field.Index getIndexOption()

Copyright © 2008-2014 JBoss, a division of Red Hat. All Rights Reserved.