Package org.dashbuilder.dataset.engine.filter

Class CoreFunction

java.lang.Object

org.dashbuilder.dataset.engine.filter.DataSetFunction

org.dashbuilder.dataset.engine.filter.CoreFunction

public class CoreFunction
extends DataSetFunction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CoreFunction.TimeFrameLimits

Field Summary

Fields inherited from class org.dashbuilder.dataset.engine.filter.DataSetFunction

columnId, context, dataColumn

Constructor Summary

Constructors

Constructor	Description
CoreFunction(DataSetFilterContext ctx, org.dashbuilder.dataset.filter.CoreFunctionFilter coreFunctionFilter)

Method Summary

Modifier and Type	Method	Description
boolean	compare(Comparable c1, Comparable c2)
Comparable	getCurrentValue()
Comparable	getParameter(int index)
List<Comparable>	getParameters()
boolean	isBetween(Comparable value)
boolean	isEqualsTo(Comparable value)
boolean	isGreaterThan(Comparable value)
boolean	isGreaterThanOrEqualsTo(Comparable value)
boolean	isLikeTo(Comparable value)	The LIKE_TO operator is intended to emulate the SQL like operator.It's used to search for a specified pattern in a data set's column.
boolean	isLowerThan(Comparable value)
boolean	isLowerThanOrEqualsTo(Comparable value)
boolean	isNotEqualsTo(Comparable value)
boolean	isNotNull(Comparable value)
boolean	isNull(Comparable value)
boolean	pass()	Evaluate the filter function.
boolean	timeFrame(Comparable value)

Methods inherited from class org.dashbuilder.dataset.engine.filter.DataSetFunction

getColumnId, getContext, getDataColumn, setColumnId, setContext

Methods inherited from class java.lang.Object

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

Constructor Detail

CoreFunction

public CoreFunction(DataSetFilterContext ctx,
                    org.dashbuilder.dataset.filter.CoreFunctionFilter coreFunctionFilter)

Method Detail

getCurrentValue

public Comparable getCurrentValue()

getParameter

public Comparable getParameter(int index)

getParameters

public List<Comparable> getParameters()

pass

public boolean pass()

Description copied from class: DataSetFunction

Evaluate the filter function.

Specified by:

pass in class DataSetFunction

isNull

public boolean isNull(Comparable value)

isNotNull

public boolean isNotNull(Comparable value)

compare

public boolean compare(Comparable c1,
                       Comparable c2)

isEqualsTo

public boolean isEqualsTo(Comparable value)

isNotEqualsTo

public boolean isNotEqualsTo(Comparable value)

isLikeTo

public boolean isLikeTo(Comparable value)

The LIKE_TO operator is intended to emulate the SQL like operator.It's used to search for a specified pattern in a data set's column.

Allowed wildcards are:

• _ - A substitute for a single character.
• % - A substitute for zero or more characters.
• [charlist] - Sets and ranges of characters to match.
• [^charlist] - Matches only a character NOT specified within the brackets.

The call getParameter(0) returns the given user's input pattern used for searching.

The implementation is supported for TEXT or LABEL column types and it's case sensitive or unsensitive depending on the boolean value returned by getParameter(1).

Parameters:

value - The existing data set column's value at a given row.

Returns:

If the string on current data set's column is like (as the SQL operator) the given user's pattern.

isLowerThan

public boolean isLowerThan(Comparable value)

isLowerThanOrEqualsTo

public boolean isLowerThanOrEqualsTo(Comparable value)

isGreaterThan

public boolean isGreaterThan(Comparable value)

isGreaterThanOrEqualsTo

public boolean isGreaterThanOrEqualsTo(Comparable value)

isBetween

public boolean isBetween(Comparable value)

timeFrame

public boolean timeFrame(Comparable value)