Package com.appiancorp.suiteapi.process.analytics2

Class SimpleColumnFilter

java.lang.Object

com.appiancorp.suiteapi.process.analytics2.BaseFilter

com.appiancorp.suiteapi.process.analytics2.SimpleColumnFilter

All Implemented Interfaces:

DeepCloneable, Filter, Serializable, Cloneable

public class SimpleColumnFilter
extends BaseFilter
implements DeepCloneable

Simple column filter which allows you to filter on any column in the report.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SimpleColumnFilter.ComparisonType

Field Summary

Fields

Modifier and Type	Field	Description
static final int	TYPE	This constant tells the backend what kind of filter this is.

Fields inherited from class com.appiancorp.suiteapi.process.analytics2.BaseFilter

LOG

Constructor Summary

Constructors

Constructor	Description
SimpleColumnFilter()
SimpleColumnFilter(Integer columnLocalId, SimpleColumnFilter.ComparisonType comparison, GenericTypedVariable constant, boolean apply)	Deprecated. since 6.1
SimpleColumnFilter(Integer columnLocalId, SimpleColumnFilter.ComparisonType comparison, TypedValue constant, boolean apply)	Constructs a new SimpleColumnFilter.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Clone this object.
boolean	equals(Object object)	Is this Filter equal to another object?
Integer	getColumnLocalId()	Gets the localId of the column on which to apply this filter.
Integer	getComparison()	Gets the comparison used for this filter.
GenericTypedVariable	getConstant()	Gets the constant used for this filter.
int	getFilterType()	Gets the simple column filter type.
static com.appian.komodo.api.ShardedProcessObjectType	getShardedProcessObjectTypeByExpression(String expr)	Not Comprehensive.
int	hashCode()	Hash code.
boolean	isReportPortletFilter()	Tells if this filter was set by the report channel.
void	setColumnLocalId(Integer columnLocalId_)	Sets the column on which to apply this filter.
void	setComparison(Integer comparison_)	Sets the comparison for this filter.
void	setConstant(GenericTypedVariable constant_)	Sets the constant used for this filter.
void	setReportPortletFilter(boolean reportFilter)	Set to true if this filter is set by the report channel.
String	toString()

Methods inherited from class com.appiancorp.suiteapi.process.analytics2.BaseFilter

getApply, setApply

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final int TYPE

This constant tells the backend what kind of filter this is.

See Also:

• Constant Field Values

Constructor Details

SimpleColumnFilter

public SimpleColumnFilter()

SimpleColumnFilter

public SimpleColumnFilter(Integer columnLocalId,
 SimpleColumnFilter.ComparisonType comparison,
 TypedValue constant,
 boolean apply)

Constructs a new SimpleColumnFilter.

Parameters:

columnLocalId -

comparison -

constant -

apply -

SimpleColumnFilter

@Deprecated
public SimpleColumnFilter(Integer columnLocalId,
 SimpleColumnFilter.ComparisonType comparison,
 GenericTypedVariable constant,
 boolean apply)

Deprecated.

since 6.1

See Also:

• SimpleColumnFilter(Integer, ComparisonType, TypedValue, boolean)

Method Details

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object object)

Is this Filter equal to another object?

Overrides:

equals in class BaseFilter

hashCode

public int hashCode()

Description copied from class: BaseFilter

Hash code.

Overrides:

hashCode in class BaseFilter

clone

public Object clone()

Clone this object.

Specified by:

clone in interface DeepCloneable

Overrides:

clone in class BaseFilter

Returns:

getFilterType

public int getFilterType()

Gets the simple column filter type. Implements abstract method BaseFilter.getFilterType.

Specified by:

getFilterType in interface Filter

Specified by:

getFilterType in class BaseFilter

Returns:

the type of the Filter. This is one of:

• 0 = SimpleColumnFilter
• 1 = LastNDaysFilter
• 2 = AheadOfScheduleFilter
• 3 = OutsideNStandardDeviationsFilter
• 4 = NotYetCompletedFilter (Deprecated)
• 5 = LastNCompletedFilter
• 6 = CompletedAheadOfScheduleFilter (Deprecated)
• 7 = BehindScheduleFilter
• 8 = DueTodayFilter
• 9 = CompletedFilter
• 10 = RunningFilter

getColumnLocalId

public Integer getColumnLocalId()

Gets the localId of the column on which to apply this filter.

Returns:

the localId of the column

See Also:

• setColumnLocalId(java.lang.Integer)

setColumnLocalId

public void setColumnLocalId(Integer columnLocalId_)

Sets the column on which to apply this filter.

Parameters:

columnLocalId_ - the localId of the column

See Also:

• getColumnLocalId()

getComparison

public Integer getComparison()

Gets the comparison used for this filter.

Returns:

Returns the comparison used in this filter. Constants for these are in: Comparisons

See Also:

• setComparison(java.lang.Integer)

setComparison

public void setComparison(Integer comparison_)

Sets the comparison for this filter.

Parameters:

comparison_ - The comparison to set.

See Also:

• getComparison()

getConstant

public GenericTypedVariable getConstant()

Gets the constant used for this filter.

Returns:

Returns the constant.

See Also:

• setConstant(com.appiancorp.suiteapi.process.GenericTypedVariable)

setConstant

public void setConstant(GenericTypedVariable constant_)

Sets the constant used for this filter.

Parameters:

constant_ - The constant to set.

See Also:

• getConstant()

isReportPortletFilter

public boolean isReportPortletFilter()

Tells if this filter was set by the report channel.

setReportPortletFilter

public void setReportPortletFilter(boolean reportFilter)

Set to true if this filter is set by the report channel.

getShardedProcessObjectTypeByExpression

public static com.appian.komodo.api.ShardedProcessObjectType getShardedProcessObjectTypeByExpression(String expr)

Not Comprehensive. Intended as an optimization which, when applicable, can reduce the number of analytics engines fielding report queries.

Parameters:

expr -

Returns:

the object type indicated by the expression