org.modeshape.search.lucene
Class IndexRules

java.lang.Object
  extended by org.modeshape.search.lucene.IndexRules

@Immutable
public class IndexRules
extends Object

The set of rules that dictate how properties should be indexed.


Nested Class Summary
static class IndexRules.Builder
          A builder of immutable IndexRules objects.
static class IndexRules.FieldType
           
static interface IndexRules.NumericRule<T>
           
static interface IndexRules.Rule
          A single rule that dictates how a single property should be indexed.
 
Field Summary
static IndexRules.Rule SKIP
           
 
Method Summary
static IndexRules.Builder createBuilder()
          Return a new builder that can be used to create IndexRules objects.
static IndexRules.Builder createBuilder(IndexRules initialRules)
          Return a new builder that can be used to create IndexRules objects.
 IndexRules.Rule getRule(Name name)
          Get the rule associated with the given property name.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SKIP

public static final IndexRules.Rule SKIP
Method Detail

getRule

public IndexRules.Rule getRule(Name name)
Get the rule associated with the given property name.

Parameters:
name - the property name, or null if the default rule is to be returned
Returns:
the rule; never null

createBuilder

public static IndexRules.Builder createBuilder()
Return a new builder that can be used to create IndexRules objects.

Returns:
a builder; never null

createBuilder

public static IndexRules.Builder createBuilder(IndexRules initialRules)
Return a new builder that can be used to create IndexRules objects.

Parameters:
initialRules - the rules that the builder should start with
Returns:
a builder; never null
Throws:
IllegalArgumentException - if the initial rules reference is null


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