com.sas.storage.olap
Class Filter

com.sas.storage.olap.Filter

All Implemented Interfaces:

java.lang.Cloneable

public class Filter
implements java.lang.Cloneable

The Filter object defines a set of filters which are used to select a set of OLAP Metadata elements (eg Dimensions, Levels, etc). The primary purpose of this object is to limit the number of arguments required in many of the MetadataInterface methods. It also leaves open the possibility that more restrictions may be available that those that are currently known. A complete list of restrictions is provided at the bottom of this documentation. Each method in the MetadataInterface that uses Restrictions clearly documents which restrictions are available. If a restriction is available, but is not used, then no filtering will take place for this particular restriction. The restrictions that are specified are applied with an implicit AND operator. For example, a Hierarchy is based on the following criteria: catalogName, schemaName, cubeName, uniqueDimensionName. If the schemaName and cubeName are specified, a set of dimensions will be returned that have a given cubeName and schemaName, regardless of the catalogName and uniqueDimensionName, which were not specified. Restrictions: Catalog Name Schema Name Unique Dimension Name Unique Hierarchy Name Unique Level Name Level Number Member Name Unique Member Name Member Label Member Type Member Tree Operator -- This restriction is applied to the resulting set of Members rather than being joined with the others by an AND operation.

Field Summary

static int	ANCESTORS_TREE_OPERATOR Ancestor member tree operator restriction.
static int	CHILDREN_TREE_OPERATOR Children tree operator restriction.
static int	DESCENDENTS_TREE_OPERATOR Descendent members restriction.
static int	PARENT_TREE_OPERATOR Parent member tree operator restriction.
static int	SELF_TREE_OPERATOR Self member tree operator restriction.
static int	SIBLINGS_TREE_OPERATOR Sibling member tree operator restriction.

Constructor Summary

Filter()

Method Summary

java.lang.String	getCatalogName() Returns the restriction used to filter by catalog name
java.lang.String	getCubeName() Returns the restriction used to filter by cube name
java.lang.String	getDimensionName() Returns the restriction used to filter by dimension name
java.lang.String	getHierarchyName() Returns the restriction used to filter by hierarchy name
java.lang.String	getLevelName() Returns the restriction used to filter by level name
int	getLevelNumber() Returns the restriction used to filter by level number
java.lang.String	getMeasureName() Returns the restriction used to filter by measure name
java.lang.String	getMemberLabel() Returns the restriction used to filter by member label
java.lang.String	getMemberName() Returns the restriction used to filter by member name
int	getMemberType() Returns the restriction used to filter by member type
java.lang.String	getNormalizedCubeName() Return the restriction used to filter by cube name, always lowercase.
java.lang.String	getPropertyName() Returns the restriction used to filter by property name
int	getPropertyType() Returns the restriction used to filter by property type
java.lang.String	getSchemaName() Returns the restriction used to filter by schema name
int	getTreeOperator() Returns the restriction used to filter by tree operator
java.lang.String	getUniqueDimensionName() Returns the restriction used to filter by unique dimension name
java.lang.String	getUniqueHierarchyName() Returns the restriction used to filter by unique hierarchy name
java.lang.String	getUniqueLevelName() Returns the restriction used to filter by unique level name
java.lang.String	getUniqueMeasureName() Returns the restriction used to filter by unique measure name
java.lang.String	getUniqueMemberName() Returns the restriction used to filter by unique member name
boolean	hasIncludeSharedDimensions() Returns the restriction used to filter by shared dimension flag
void	reset() Clears all the fields for this filter object.
void	setCatalogName(java.lang.String catalogName) Sets the restriction used to filter by catalog name
void	setCubeName(java.lang.String cubeName) Sets the restriction used to filter by cube name
void	setDimensionName(java.lang.String dimensionName) Sets the restriction used to filter by dimension name
void	setHierarchyName(java.lang.String hierarchyName) Sets the restriction used to filter by hierarchy name
void	setIncludeSharedDimensions(boolean sharedDimFlag) Sets the restriction used to include shared dimensions.
void	setLevelName(java.lang.String levelName) Sets the restriction used to filter by level name
void	setLevelNumber(int levelNumber) Sets the restriction used to filter by level number
void	setMeasureName(java.lang.String measureName) Sets the restriction used to filter by measue name
void	setMemberLabel(java.lang.String memberLabel) Sets the restriction used to filter by member label
void	setMemberName(java.lang.String memberName) Sets the restriction used to filter by member name
void	setMemberType(int memberType) Sets the restriction used to filter by member type
void	setPropertyName(java.lang.String propertyName) Sets the restriction used to filter by property name
void	setPropertyType(int propertyType) Sets the restriction used to filter by property type
void	setSchemaName(java.lang.String schemaName) Sets the restriction used to filter by schema name
void	setTreeOperator(int treeOperator) Set the restriction to get member info.
void	setUniqueDimensionName(java.lang.String uniqueDimensionName) Sets the restriction used to filter by unique dimension name
void	setUniqueHierarchyName(java.lang.String uniqueHierarchyName) Sets the restriction used to filter by unique hierarchy name
void	setUniqueLevelName(java.lang.String uniqueLevelName) Sets the restriction used to filter by unique level name
void	setUniqueMeasureName(java.lang.String uniqueMeasureName) Sets the restriction used to filter by unique measure name
void	setUniqueMemberName(java.lang.String uniqueMemberName) Sets the restriction used to filter by unique member name

Field Detail

ANCESTORS_TREE_OPERATOR

public static int ANCESTORS_TREE_OPERATOR

Ancestor member tree operator restriction. Used to get all the ancestor members for a member

CHILDREN_TREE_OPERATOR

public static int CHILDREN_TREE_OPERATOR

Children tree operator restriction. Used to get children members for a member

SIBLINGS_TREE_OPERATOR

public static int SIBLINGS_TREE_OPERATOR

Sibling member tree operator restriction. Used to get all members at the same level for a member

PARENT_TREE_OPERATOR

public static int PARENT_TREE_OPERATOR

Parent member tree operator restriction. Used to get parent member for a member

SELF_TREE_OPERATOR

public static int SELF_TREE_OPERATOR

Self member tree operator restriction. Used to get self member info for a member

DESCENDENTS_TREE_OPERATOR

public static int DESCENDENTS_TREE_OPERATOR

Descendent members restriction. Used to get descendent members for a member

Constructor Detail

Filter

public Filter()

Method Detail

reset

public void reset()

Clears all the fields for this filter object.

setCatalogName

public void setCatalogName(java.lang.String catalogName)

Sets the restriction used to filter by catalog name

Parameters:

catalogName - The restriction used to filter by catalog name

getCatalogName

public java.lang.String getCatalogName()

Returns the restriction used to filter by catalog name

setSchemaName

public void setSchemaName(java.lang.String schemaName)

Sets the restriction used to filter by schema name

Parameters:

schemaName - The restriction used to filter by schema name

getSchemaName

public java.lang.String getSchemaName()

Returns the restriction used to filter by schema name

setCubeName

public void setCubeName(java.lang.String cubeName)

Sets the restriction used to filter by cube name

Parameters:

cubeName - The restriction used to filter by cube name

getCubeName

public java.lang.String getCubeName()

Returns the restriction used to filter by cube name

getNormalizedCubeName

public java.lang.String getNormalizedCubeName()

Return the restriction used to filter by cube name, always lowercase. This is a convenience method for cubename comparison

setDimensionName

public void setDimensionName(java.lang.String dimensionName)

Sets the restriction used to filter by dimension name

Parameters:

dimensionName - The restriction used to filter by dimension name

getDimensionName

public java.lang.String getDimensionName()

Returns the restriction used to filter by dimension name

setUniqueDimensionName

public void setUniqueDimensionName(java.lang.String uniqueDimensionName)

Sets the restriction used to filter by unique dimension name

Parameters:

uniqueDimensionName - The restriction used to filter by unique dimension name

getUniqueDimensionName

public java.lang.String getUniqueDimensionName()

Returns the restriction used to filter by unique dimension name

setHierarchyName

public void setHierarchyName(java.lang.String hierarchyName)

Sets the restriction used to filter by hierarchy name

Parameters:

hierarchyName - The restriction used to filter by hierarchy name

getHierarchyName

public java.lang.String getHierarchyName()

Returns the restriction used to filter by hierarchy name

setUniqueHierarchyName

public void setUniqueHierarchyName(java.lang.String uniqueHierarchyName)

Sets the restriction used to filter by unique hierarchy name

Parameters:

uniqueHierarchyName - The restriction used to filter by unique hierarchy name

getUniqueHierarchyName

public java.lang.String getUniqueHierarchyName()

Returns the restriction used to filter by unique hierarchy name

setLevelName

public void setLevelName(java.lang.String levelName)

Sets the restriction used to filter by level name

Parameters:

levelName - The restriction used to filter by level name

getLevelName

public java.lang.String getLevelName()

Returns the restriction used to filter by level name

setUniqueLevelName

public void setUniqueLevelName(java.lang.String uniqueLevelName)

Sets the restriction used to filter by unique level name

Parameters:

uniqueLevelName - The restriction used to filter by unique level name

getUniqueLevelName

public java.lang.String getUniqueLevelName()

Returns the restriction used to filter by unique level name

setLevelNumber

public void setLevelNumber(int levelNumber)

Sets the restriction used to filter by level number

Parameters:

levelNumber - The restriction used to filter by level number

getLevelNumber

public int getLevelNumber()

Returns the restriction used to filter by level number

setMeasureName

public void setMeasureName(java.lang.String measureName)

Sets the restriction used to filter by measue name

Parameters:

measureName - The restriction used to filter by measure name

getMeasureName

public java.lang.String getMeasureName()

Returns the restriction used to filter by measure name

setUniqueMeasureName

public void setUniqueMeasureName(java.lang.String uniqueMeasureName)

Sets the restriction used to filter by unique measure name

Parameters:

uniqueMeasureName - The restriction used to filter by unique measure name

getUniqueMeasureName

public java.lang.String getUniqueMeasureName()

Returns the restriction used to filter by unique measure name

setMemberName

public void setMemberName(java.lang.String memberName)

Sets the restriction used to filter by member name

Parameters:

memberName - The restriction used to filter by member name

getMemberName

public java.lang.String getMemberName()

Returns the restriction used to filter by member name

setUniqueMemberName

public void setUniqueMemberName(java.lang.String uniqueMemberName)

Sets the restriction used to filter by unique member name

Parameters:

uniqueMemberName - The restriction used to filter by unique member name

getUniqueMemberName

public java.lang.String getUniqueMemberName()

Returns the restriction used to filter by unique member name

setMemberLabel

public void setMemberLabel(java.lang.String memberLabel)

Sets the restriction used to filter by member label

Parameters:

memberLabel - The restriction used to filter by member label

getMemberLabel

public java.lang.String getMemberLabel()

Returns the restriction used to filter by member label

setMemberType

public void setMemberType(int memberType)

Sets the restriction used to filter by member type

Parameters:

memberType - The restriction used to filter by member type

getMemberType

public int getMemberType()

Returns the restriction used to filter by member type

setTreeOperator

public void setTreeOperator(int treeOperator)

Set the restriction to get member info. The tree operator restriction is used to get member info based on a given member. For example get all the ancestors for a given member, or all the siblings of a given member. The constants for tree operations are ANCESTORS_TREE_OPERATOR, CHILDREN_TREE_OPERATOR, SIBLINGS_TREE_OPERATOR, PARENT_TREE_OPERATOR, SELF_TREE_OPERATOR, DESCENDENTS_TREE_OPERATOR A user can specify a MEMBER_UNIQUE_NAME restriction and the tree operator (ANCESTORS, CHILDREN, SIBLINGS, PARENT, DESCENDANTS, SELF) to obtain the desired set of members. The set of members returned may not be in the expected order i.e. a request for all the ancestors may not return members in order of parent, grandparent, great grandparent.... The caller of this method can order this by using the level depth for each member.

Parameters:

treeOperator - The restriction used to apply tree operator

getTreeOperator

public int getTreeOperator()

Returns the restriction used to filter by tree operator

setPropertyName

public void setPropertyName(java.lang.String propertyName)

Sets the restriction used to filter by property name

Parameters:

propertyName - The restriction used to filter by property name

getPropertyName

public java.lang.String getPropertyName()

Returns the restriction used to filter by property name

setPropertyType

public void setPropertyType(int propertyType)

Sets the restriction used to filter by property type

Parameters:

propertyType - The restriction used to filter by property type

getPropertyType

public int getPropertyType()

Returns the restriction used to filter by property type

setIncludeSharedDimensions

public void setIncludeSharedDimensions(boolean sharedDimFlag)

Sets the restriction used to include shared dimensions. Do not set Cube or any other restriction when using this flag, not supported by the OLAP server

Parameters:

propertyType - The restriction used to filter by property type

hasIncludeSharedDimensions

public boolean hasIncludeSharedDimensions()

Returns the restriction used to filter by shared dimension flag