Class SimpleColumnFilter
java.lang.Object
com.appiancorp.suiteapi.process.analytics2.BaseFilter
com.appiancorp.suiteapi.process.analytics2.SimpleColumnFilter
- All Implemented Interfaces:
DeepCloneable
,Filter
,Serializable
,Cloneable
Simple column filter which allows you to filter on any column in the report.
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
This constant tells the backend what kind of filter this is.Fields inherited from class com.appiancorp.suiteapi.process.analytics2.BaseFilter
LOG
-
Constructor Summary
ConstructorDescriptionSimpleColumnFilter
(Integer columnLocalId, SimpleColumnFilter.ComparisonType comparison, GenericTypedVariable constant, boolean apply) Deprecated.since 6.1SimpleColumnFilter
(Integer columnLocalId, SimpleColumnFilter.ComparisonType comparison, TypedValue constant, boolean apply) Constructs a new SimpleColumnFilter. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Clone this object.boolean
Is this Filter equal to another object?Gets the localId of the column on which to apply this filter.Gets the comparison used for this filter.Gets the constant used for this filter.int
Gets the simple column filter type.static com.appian.komodo.api.ShardedProcessObjectType
Not Comprehensive.int
hashCode()
Hash code.boolean
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.toString()
Methods inherited from class com.appiancorp.suiteapi.process.analytics2.BaseFilter
getApply, setApply
-
Field Details
-
TYPE
public static final int TYPEThis constant tells the backend what kind of filter this is.- See Also:
-
-
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
-
-
Method Details
-
toString
-
equals
Is this Filter equal to another object?- Overrides:
equals
in classBaseFilter
-
hashCode
public int hashCode()Description copied from class:BaseFilter
Hash code.- Overrides:
hashCode
in classBaseFilter
-
clone
Clone this object.- Specified by:
clone
in interfaceDeepCloneable
- Overrides:
clone
in classBaseFilter
- Returns:
-
getFilterType
public int getFilterType()Gets the simple column filter type. Implements abstract method BaseFilter.getFilterType.- Specified by:
getFilterType
in interfaceFilter
- Specified by:
getFilterType
in classBaseFilter
- 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
- 0 =
-
getColumnLocalId
Gets the localId of the column on which to apply this filter.- Returns:
- the localId of the column
- See Also:
-
setColumnLocalId
Sets the column on which to apply this filter.- Parameters:
columnLocalId_
- the localId of the column- See Also:
-
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
Sets the comparison for this filter.- Parameters:
comparison_
- The comparison to set.- See Also:
-
getConstant
Gets the constant used for this filter.- Returns:
- Returns the constant.
- See Also:
-
setConstant
Sets the constant used for this filter.- Parameters:
constant_
- The constant to set.- See Also:
-
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
-