com.partnersoft.io

Class DataFilterExpression

java.lang.Object

com.partnersoft.io.DataFilterExpression

All Implemented Interfaces:

Coggable, Immutable, DataFilterElement

public class DataFilterExpression
extends java.lang.Object
implements DataFilterElement, Immutable

Abstraction of an SQL where clause. Expression for defining how to filter a DataRecordSource.

Copyright 2008 Partner Software, Inc.

Author:

Rich Stepanski

Field Summary

Fields

Modifier and Type	Field and Description
protected DataFilterElement	leftElem Left of operator DataFilterElement
protected DataFilterOperator	operator DataFilterOperator to apply
protected DataFilterElement	rightElem Right of operator DataFilterElement

Constructor Summary

Constructors

Constructor and Description
DataFilterExpression(Cog cog) Copy constructor for this Expression.
DataFilterExpression(DataFilterElement leftElem, DataFilterOperator operator, DataFilterElement rightElem) Creates a new DataRecordFilter.
DataFilterExpression(java.lang.String fieldName, DataFilterOperator op, java.lang.Object value) Simplified constructor for generating a DataFilterExpression with passed name, op, and value.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
DataFilterElement	getLeftElement() Left of operator DataFilterElement
DataFilterOperator	getOperator() DataFilterOperator
DataFilterElement	getRightElement() Right of operator DataFilterElement
int	hashCode()
java.util.List<DataFilterExpression>	listExpressionComponents() Returns list of basic DataFilterExpressions that this expression is composed of.
static DataFilterExpression	parseText(java.lang.String fieldName, java.lang.String text) Deprecated. Antlr parsing should no longer be used.
Cog	toCog() Returns the complete internal state of this object in the form of a Cog.
java.lang.String	toString()
java.lang.String	toStringWithoutFieldNames() Returns a String representation of this expression that removes all field names.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

leftElem

protected final DataFilterElement leftElem

Left of operator DataFilterElement

operator

protected final DataFilterOperator operator

DataFilterOperator to apply

rightElem

protected final DataFilterElement rightElem

Right of operator DataFilterElement

Constructor Detail

DataFilterExpression

public DataFilterExpression(DataFilterElement leftElem,
                    DataFilterOperator operator,
                    DataFilterElement rightElem)

Creates a new DataRecordFilter.

Parameters:

leftElem - - DataFilterElement for left side of this expression

operator - - DataFilterOperator for this expression

rightElem - - DataFilterElement for right side of this expression

DataFilterExpression

public DataFilterExpression(java.lang.String fieldName,
                    DataFilterOperator op,
                    java.lang.Object value)

Simplified constructor for generating a DataFilterExpression with passed name, op, and value.

Parameters:

fieldName - - Name of field for this expression.

op - - DataFilterOperator for this expression

value - - Value for this expression.

DataFilterExpression

public DataFilterExpression(Cog cog)

Copy constructor for this Expression.

Parameters:

cog - - DataFilterExpression Cog to pull state from.

Method Detail

getLeftElement

public DataFilterElement getLeftElement()

Left of operator DataFilterElement

Returns:

left of operator DataFilterElement

getRightElement

public DataFilterElement getRightElement()

Right of operator DataFilterElement

Returns:

right of operator DataFilterElement

getOperator

public DataFilterOperator getOperator()

DataFilterOperator

Returns:

DataFilterOperator

listExpressionComponents

public java.util.List<DataFilterExpression> listExpressionComponents()

Returns list of basic DataFilterExpressions that this expression is composed of. Each element of returned list has left and right elements that are not DataFilterExpressions.

Returns:

List of DataFilterExpressions this expression is composed of.

toStringWithoutFieldNames

public java.lang.String toStringWithoutFieldNames()

Returns a String representation of this expression that removes all field names. This is used by FormCogFilterField for setting String values that can be parsed by

Returns:

String representation of this expression.

parseText

public static DataFilterExpression parseText(java.lang.String fieldName,
                             java.lang.String text)
                                      throws org.antlr.runtime.RecognitionException

Deprecated. Antlr parsing should no longer be used.

Creates a DataFilterExpression from the passed text. (@link com.partnersoft.io.FilterGrammer.g)

Parameters:

fieldName - - Name of field to parse

text - - Text to parse.

Returns:

DataFilterExpression for passed text.

Throws:

org.antlr.runtime.RecognitionException - if text is in incorrect format.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toCog

public Cog toCog()

Description copied from interface: Coggable

Returns the complete internal state of this object in the form of a Cog.

Specified by:

toCog in interface Coggable

Returns:

Cog representing the internal state of this object