|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.modeshape.search.lucene.IndexRules.Builder
@NotThreadSafe public static class IndexRules.Builder
A builder of immutable IndexRules
objects.
Method Summary | ||
---|---|---|
IndexRules.Builder |
binaryField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
boolean fullTextSearchable)
Define a binary-based field in the indexes. |
|
IndexRules.Builder |
booleanField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index)
Define a boolean-based field in the indexes. |
|
IndexRules |
build()
Build the indexing rules. |
|
IndexRules.Builder |
dateField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index)
Define a date-based field in the indexes. |
|
IndexRules.Builder |
dateField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
Long minValue)
Define a date-based field in the indexes. |
|
IndexRules.Builder |
dateField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
Long minValue,
Long maxValue)
Define a date-based field in the indexes. |
|
IndexRules.Builder |
defaultTo(org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
boolean canBeReference,
boolean fullTextSearchable)
Define a string-based field as the default. |
|
IndexRules.Builder |
doubleField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index)
Define a double-based field in the indexes. |
|
IndexRules.Builder |
doubleField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
Double minValue)
Define a double-based field in the indexes. |
|
IndexRules.Builder |
doubleField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
Double minValue,
Double maxValue)
Define a double-based field in the indexes. |
|
IndexRules.Builder |
floatField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index)
Define a float-based field in the indexes. |
|
IndexRules.Builder |
floatField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
Float minValue)
Define a float-based field in the indexes. |
|
IndexRules.Builder |
floatField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
Float minValue,
Float maxValue)
Define a float-based field in the indexes. |
|
IndexRules.Builder |
integerField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index)
Define a integer-based field in the indexes. |
|
IndexRules.Builder |
integerField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
Integer minValue)
Define a integer-based field in the indexes. |
|
IndexRules.Builder |
integerField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
Integer minValue,
Integer maxValue)
Define a integer-based field in the indexes. |
|
IndexRules.Builder |
longField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index)
Define a long-based field in the indexes. |
|
IndexRules.Builder |
longField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
Long minValue)
Define a long-based field in the indexes. |
|
IndexRules.Builder |
longField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
Long minValue,
Long maxValue)
Define a long-based field in the indexes. |
|
protected
|
numericField(Name name,
IndexRules.FieldType type,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
T minValue,
T maxValue)
|
|
IndexRules.Builder |
referenceField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index)
Define a reference-based field in the indexes. |
|
IndexRules.Builder |
skip(Name... namesToIndex)
Mark the properties with the supplied names to be skipped from indexing. |
|
IndexRules.Builder |
stringField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
boolean canBeReference,
boolean fullTextSearchable)
Define a string-based field in the indexes. |
|
IndexRules.Builder |
weakReferenceField(Name name,
org.apache.lucene.document.Field.Store store,
org.apache.lucene.document.Field.Index index,
boolean fullTextSearchable)
Define a weak-reference-based field in the indexes. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public IndexRules.Builder skip(Name... namesToIndex)
namesToIndex
- the names of the properties that are to be skipped
public IndexRules.Builder defaultTo(org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, boolean canBeReference, boolean fullTextSearchable)
store
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
canBeReference
- true if this field can contain references; or false if it cannotfullTextSearchable
- true if this field is full-text searchable, or false otherwise
public IndexRules.Builder stringField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, boolean canBeReference, boolean fullTextSearchable)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
canBeReference
- true if this field can contain references; or false if it cannotfullTextSearchable
- true if this field is full-text searchable, or false otherwise
public IndexRules.Builder binaryField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, boolean fullTextSearchable)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
fullTextSearchable
- true if this field is full-text searchable, or false otherwise
public IndexRules.Builder referenceField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
public IndexRules.Builder weakReferenceField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, boolean fullTextSearchable)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
fullTextSearchable
- true if this field is full-text searchable, or false otherwise
protected <T> IndexRules.Builder numericField(Name name, IndexRules.FieldType type, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, T minValue, T maxValue)
public IndexRules.Builder booleanField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
public IndexRules.Builder integerField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, Integer minValue, Integer maxValue)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
minValue
- the minimum value for this field, or null if there is no minimum valuemaxValue
- the maximum value for this field, or null if there is no maximum value
public IndexRules.Builder longField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, Long minValue, Long maxValue)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
minValue
- the minimum value for this field, or null if there is no minimum valuemaxValue
- the maximum value for this field, or null if there is no maximum value
public IndexRules.Builder dateField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, Long minValue, Long maxValue)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
minValue
- the minimum value for this field, or null if there is no minimum valuemaxValue
- the maximum value for this field, or null if there is no maximum value
public IndexRules.Builder floatField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, Float minValue, Float maxValue)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
minValue
- the minimum value for this field, or null if there is no minimum valuemaxValue
- the maximum value for this field, or null if there is no maximum value
public IndexRules.Builder doubleField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, Double minValue, Double maxValue)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
minValue
- the minimum value for this field, or null if there is no minimum valuemaxValue
- the maximum value for this field, or null if there is no maximum value
public IndexRules.Builder integerField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, Integer minValue)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
minValue
- the minimum value for this field, or null if there is no minimum value
public IndexRules.Builder longField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, Long minValue)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
minValue
- the minimum value for this field, or null if there is no minimum value
public IndexRules.Builder dateField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, Long minValue)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
minValue
- the minimum value for this field, or null if there is no minimum value
public IndexRules.Builder floatField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, Float minValue)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
minValue
- the minimum value for this field, or null if there is no minimum value
public IndexRules.Builder doubleField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index, Double minValue)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
minValue
- the minimum value for this field, or null if there is no minimum value
public IndexRules.Builder integerField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
public IndexRules.Builder longField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
public IndexRules.Builder dateField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
public IndexRules.Builder floatField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
public IndexRules.Builder doubleField(Name name, org.apache.lucene.document.Field.Store store, org.apache.lucene.document.Field.Index index)
name
- the name of the fieldstore
- the storage setting, or null if the field should be stored
index
- the index setting, or null if the field should be indexed but not analyzed
public IndexRules build()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |