org.apache.blur.analysis.type
Class FieldLessFieldTypeDefinition

java.lang.Object
  extended by org.apache.blur.analysis.FieldTypeDefinition
      extended by org.apache.blur.analysis.type.FieldLessFieldTypeDefinition

public class FieldLessFieldTypeDefinition
extends FieldTypeDefinition


Field Summary
static String NAME
           
static org.apache.lucene.document.FieldType TYPE_NOT_STORED
           
 
Constructor Summary
FieldLessFieldTypeDefinition()
           
 
Method Summary
 boolean checkSupportForCustomQuery()
           
 boolean checkSupportForFuzzyQuery()
           
 boolean checkSupportForPrefixQuery()
           
 boolean checkSupportForRegexQuery()
           
 boolean checkSupportForSorting()
           
 boolean checkSupportForWildcardQuery()
           
 void configure(String fieldNameForThisInstance, Map<String,String> properties, org.apache.hadoop.conf.Configuration configuration)
          Configures the field type.
 org.apache.lucene.analysis.Analyzer getAnalyzerForIndex(String fieldName)
          Gets the Analyzer for indexing this should be the same for the querying unless you have a good reason.
 org.apache.lucene.analysis.Analyzer getAnalyzerForQuery(String fieldName)
          Gets the Analyzer for querying this should be the same for the indexing unless you have a good reason.
 Iterable<? extends org.apache.lucene.document.Field> getFieldsForColumn(String family, Column column)
          Gets the Fields for indexing from a single Column.
 Iterable<? extends org.apache.lucene.document.Field> getFieldsForSubColumn(String family, Column column, String subName)
          Gets the Fields for indexing from a single Column, but should not be stored because the original value should be stored in the main Column.
 String getName()
          Gets the name of the field type.
 org.apache.lucene.search.SortField getSortField(boolean reverse)
           
 boolean isNumeric()
           
 
Methods inherited from class org.apache.blur.analysis.FieldTypeDefinition
getAlternateFieldNames, getColumnName, getCustomQuery, getFamily, getFieldType, getProperties, getSubColumnName, isFieldLessIndexed, isSortEnable, setColumnName, setFamily, setFieldLessIndexed, setFieldType, setProperties, setSortEnable, setSubColumnName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NAME

public static final String NAME
See Also:
Constant Field Values

TYPE_NOT_STORED

public static final org.apache.lucene.document.FieldType TYPE_NOT_STORED
Constructor Detail

FieldLessFieldTypeDefinition

public FieldLessFieldTypeDefinition()
Method Detail

getName

public String getName()
Description copied from class: FieldTypeDefinition
Gets the name of the field type.

Specified by:
getName in class FieldTypeDefinition
Returns:
the name.

configure

public void configure(String fieldNameForThisInstance,
                      Map<String,String> properties,
                      org.apache.hadoop.conf.Configuration configuration)
Description copied from class: FieldTypeDefinition
Configures the field type.

Specified by:
configure in class FieldTypeDefinition
properties - the properties.

getFieldsForColumn

public Iterable<? extends org.apache.lucene.document.Field> getFieldsForColumn(String family,
                                                                               Column column)
Description copied from class: FieldTypeDefinition
Gets the Fields for indexing from a single Column.

Specified by:
getFieldsForColumn in class FieldTypeDefinition
column - the Column
Returns:
the Iterable of fields.

getFieldsForSubColumn

public Iterable<? extends org.apache.lucene.document.Field> getFieldsForSubColumn(String family,
                                                                                  Column column,
                                                                                  String subName)
Description copied from class: FieldTypeDefinition
Gets the Fields for indexing from a single Column, but should not be stored because the original value should be stored in the main Column.

Specified by:
getFieldsForSubColumn in class FieldTypeDefinition
column - the Column
Returns:
the Iterable of fields.

getAnalyzerForIndex

public org.apache.lucene.analysis.Analyzer getAnalyzerForIndex(String fieldName)
Description copied from class: FieldTypeDefinition
Gets the Analyzer for indexing this should be the same for the querying unless you have a good reason.

Specified by:
getAnalyzerForIndex in class FieldTypeDefinition
Parameters:
fieldName - the field name to get the analyzer, this could be the base field name or the alternative.
Returns:
the Analyzer.

getAnalyzerForQuery

public org.apache.lucene.analysis.Analyzer getAnalyzerForQuery(String fieldName)
Description copied from class: FieldTypeDefinition
Gets the Analyzer for querying this should be the same for the indexing unless you have a good reason.

Specified by:
getAnalyzerForQuery in class FieldTypeDefinition
Parameters:
fieldName - the field name to get the analyzer, this could be the base field name or the alternative.
Returns:
the Analyzer.

checkSupportForFuzzyQuery

public boolean checkSupportForFuzzyQuery()
Specified by:
checkSupportForFuzzyQuery in class FieldTypeDefinition

checkSupportForWildcardQuery

public boolean checkSupportForWildcardQuery()
Specified by:
checkSupportForWildcardQuery in class FieldTypeDefinition

checkSupportForPrefixQuery

public boolean checkSupportForPrefixQuery()
Specified by:
checkSupportForPrefixQuery in class FieldTypeDefinition

checkSupportForRegexQuery

public boolean checkSupportForRegexQuery()
Specified by:
checkSupportForRegexQuery in class FieldTypeDefinition

isNumeric

public boolean isNumeric()
Specified by:
isNumeric in class FieldTypeDefinition

checkSupportForCustomQuery

public boolean checkSupportForCustomQuery()
Specified by:
checkSupportForCustomQuery in class FieldTypeDefinition

checkSupportForSorting

public boolean checkSupportForSorting()
Specified by:
checkSupportForSorting in class FieldTypeDefinition

getSortField

public org.apache.lucene.search.SortField getSortField(boolean reverse)
Specified by:
getSortField in class FieldTypeDefinition


Copyright © 2012-2014 The Apache Software Foundation. All Rights Reserved.