Class QueryConfigHandler

  extended by org.apache.lucene.util.AttributeSource
      extended by org.apache.lucene.queryParser.core.config.QueryConfigHandler
Direct Known Subclasses:

public abstract class QueryConfigHandler
extends AttributeSource

This class can be used to hold any query configuration and no field configuration. For field configuration, it creates a empty FieldConfig object and delegate it to field config listeners, these are responsible for setting up all the field configuration. QueryConfigHandler should be extended by classes that intends to provide configuration to QueryNodeProcessor objects. This class extends AttributeSource, so Attributes can be attached to it. The class that extends QueryConfigHandler should also provide FieldConfig objects for each collection field.

See Also:
Attribute, FieldConfig, FieldConfigListener, QueryConfigHandler

Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.util.AttributeSource
AttributeSource.AttributeFactory, AttributeSource.State
Constructor Summary
Method Summary
 void addFieldConfigListener(FieldConfigListener listener)
          Adds a listener.
 FieldConfig getFieldConfig(CharSequence fieldName)
          Returns an implementation of FieldConfig for a specific field name.
Methods inherited from class org.apache.lucene.util.AttributeSource
addAttribute, addAttributeImpl, captureState, clearAttributes, cloneAttributes, equals, getAttribute, getAttributeClassesIterator, getAttributeFactory, getAttributeImplsIterator, hasAttribute, hasAttributes, hashCode, restoreState, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail


public QueryConfigHandler()
Method Detail


public FieldConfig getFieldConfig(CharSequence fieldName)
Returns an implementation of FieldConfig for a specific field name. If the implemented QueryConfigHandler does not know a specific field name, it may return null, indicating there is no configuration for that field.

fieldName - the field name
a FieldConfig object containing the field name configuration or null, if the implemented QueryConfigHandler has no configuration for that field


public void addFieldConfigListener(FieldConfigListener listener)
Adds a listener. The added listeners are called in the order they are added.

listener - the listener to be added

Copyright © 2000-2010 Apache Software Foundation. All Rights Reserved.