com.endeca.navigation.analytics
Class ExprKey

java.lang.Object
  com.endeca.navigation.analytics.ExprKey

All Implemented Interfaces:

Expr, QueryNode

public class ExprKey
extends Object
implements Expr

Instances of ExprKey represent record field names. The fields are Endeca properties or dimensions.

Constructor Summary

ExprKey(String _fieldName)
Creates a new ExprKey expression node representing the specified record field name.

Method Summary

String	getFieldName() Gets the field name for this ExprKey.
void	setFieldName(String fieldName) Sets the field name for this ExprKey.
String	toString() Returns the string form of this ExprKey.
String	toWire() Returns the wire form of this ExprKey.
void	validateSyntax() Validates the syntax of this ExprKey.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExprKey

public ExprKey(String _fieldName)

Creates a new ExprKey expression node representing the specified record field name.

Parameters:

_fieldName - the name of an Endeca property or dimension.

Method Detail

getFieldName

public String getFieldName()

Gets the field name for this ExprKey.

Returns:

The name of an Endeca property or dimension that is the fieldName setting for this ExprKey.

setFieldName

public void setFieldName(String fieldName)

Sets the field name for this ExprKey.

Parameters:

fieldName - the name of an Endeca property or dimension.

toString

public String toString()

Returns the string form of this ExprKey. These are of the format "price" or "revenue ($)".

Specified by:

toString in interface QueryNode

Overrides:

toString in class Object

Returns:

A string representation of this ExprKey in the specified format.

toWire

public String toWire()

Returns the wire form of this ExprKey. This method is not intended for public use because the wire format is subject to change.

Specified by:

toWire in interface QueryNode

Returns:

A wire format representation of this ExprKey.

validateSyntax

public void validateSyntax()
                    throws SyntaxException

Validates the syntax of this ExprKey. An ExprKey is valid if the fieldName is non-null and non-empty.

Specified by:

validateSyntax in interface QueryNode

Throws:

SyntaxException - if the syntax requirements are not satisfied.