com.yahoo.search.query.profile

Class QueryProfileVisitor

java.lang.Object

com.yahoo.search.query.profile.QueryProfileVisitor

Direct Known Subclasses:

FieldDescriptionQueryProfileVisitor, PrefixQueryProfileVisitor, SingleValueQueryProfileVisitor

abstract class QueryProfileVisitor
extends Object

Instances of this is used to visit nodes in a graph of query profiles Visitor are called in the following sequence on each query profile: enter=enter(referenceName); onQueryProfile(this) if (enter) { getLocalKey() ...calls on nested content found in variants, this and inherited, in that order leave(referenceName) } The first enter call will be on the root node, which has an empt reference name.

Author:

bratseth

Constructor Summary

Constructors

Constructor and Description
QueryProfileVisitor()

Method Summary

Modifier and Type	Method and Description
(package private) void	acceptValue(String key, Object value, DimensionBinding dimensionBinding, QueryProfile owner) Calls onValue or onQueryProfile on this and visits the content if it's a profile
boolean	enter(String name) Called when a new nested profile in the graph is entered.
abstract String	getLocalKey() Returns the current local key which should be visited in the last entered sub-profile (or in the top level profile if none is entered), or null to visit all content
abstract boolean	isDone() Returns whether this visitor is done visiting what it needed to visit at this point
void	leave(String name) Called when the last entered nested profile is left.
abstract void	onQueryProfile(QueryProfile profile, DimensionBinding binding, QueryProfile owner) Called when a query profile is encountered.
abstract void	onValue(String localName, Object value, DimensionBinding binding, QueryProfile owner) Called when a value (not a query profile) is encountered.
boolean	visitInherited() Returns whether we should, at this point, visit inherited profiles.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

QueryProfileVisitor

QueryProfileVisitor()

Method Detail

enter

public boolean enter(String name)

Called when a new nested profile in the graph is entered. This default implementation does nothing but returning true. If the node is entered (if true is returned from this), a corresponding leave(String) call will happen later.

Parameters:

name - the name this profile is nested as, or the empty string if we are entering the root profile

Returns:

whether we should visit the content of this node or not

leave

public void leave(String name)

Called when the last entered nested profile is left. That is: One leave call is made for each enter call which returns true, but due to nesting those calls are not necessarily alternating. This default implementation does nothing.

onValue

public abstract void onValue(String localName,
                             Object value,
                             DimensionBinding binding,
                             QueryProfile owner)

Called when a value (not a query profile) is encountered.

Parameters:

localName - the local name of this value (the full name, if needed, must be reconstructed by the information given by the history of enter(String) and leave(String) calls

value - the value

binding - the binding this holds for

owner - the query profile having this value, or null only when profile is the root profile

onQueryProfile

public abstract void onQueryProfile(QueryProfile profile,
                                    DimensionBinding binding,
                                    QueryProfile owner)

Called when a query profile is encountered.

Parameters:

profile - the query profile reference encountered

binding - the binding this holds for

owner - the profile making this reference, or null only when profile is the root profile

isDone

public abstract boolean isDone()

Returns whether this visitor is done visiting what it needed to visit at this point

visitInherited

public boolean visitInherited()

Returns whether we should, at this point, visit inherited profiles. This default implementation returns true

getLocalKey

public abstract String getLocalKey()

Returns the current local key which should be visited in the last entered sub-profile (or in the top level profile if none is entered), or null to visit all content

acceptValue

final void acceptValue(String key,
                       Object value,
                       DimensionBinding dimensionBinding,
                       QueryProfile owner)

Calls onValue or onQueryProfile on this and visits the content if it's a profile