atg.repository

Class ContextFilteringRules

java.lang.Object

atg.repository.ContextFilteringRules

public class ContextFilteringRules
extends java.lang.Object

A structure representing a set of context property filtering rules. Contains an list of ContextFilterRule objects; The order of the objects is immaterial. Objects of this type can fall into one of the two categories, one a global rule which is a single rule for filtering and does not refer to specific membership contexts, second an array of context specific rules.

Filtering constraints can be added to an application's repository query through the QueryBuilder.addContextMembershipFilters(Query, ContextFilteringRules) method or as a post-processing step on the results. One can use the RepositoryItemContextFilter class to filter an array of RepositoryItems. Note that post filtering is much less efficient than repository filtering.

See Also:

ContextFilteringRule, QueryBuilder.addContextMembershipFilters(Query, ContextFilteringRules)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
ContextFilteringRules(ContextFilteringRule[] pRules)
ContextFilteringRules(GlobalContextType pGlobalContextType)

Method Summary

Modifier and Type	Method and Description
void	addRule(ContextFilteringRule pContextFilteringRule) Adds the specified ContextFilteringRule to the end of the list of filtering rules.
ContextFilteringRules	copy() Returns a deep copy of this object
boolean	equals(java.lang.Object obj) Returns true if the given ContextFilteringRules has same number of elements as this one and each individual ContextFilteringRule object in the given ContextFilteringRules equals (via its equals method) the corresponding ContextFilteringRule in this ContextFilteringRules object.
RepositoryItem[]	filter(RepositoryItem[] pItems) Filter elements based on context membership property value.
GlobalContextType	getGlobalContextType()
int	getNumRules() Returns the number of filtering rules.
ContextFilteringRule	getRule(int pIndex) Returns the filtering rule at the specified index.
int	hashCode() Return an integer hash code for this object
boolean	isEmpty() Returns true if there are no ContextFilteringRules rules.
boolean	isGlobal() Is this rules object a global rule as opposed to a rules comprised of other ContextFilteringRule objects.
void	removeRule(ContextFilteringRule pContextFilteringRule) Removes the filtering rule at the specified index.
java.lang.String	toString() Returns the string representation of the object.
java.lang.String	toString(java.lang.String pIndent) Returns the string representation of the object, indenting the text using the specified pIndent string.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ContextFilteringRules

public ContextFilteringRules(ContextFilteringRule[] pRules)

ContextFilteringRules

public ContextFilteringRules(GlobalContextType pGlobalContextType)

Method Detail

isGlobal

public boolean isGlobal()

Is this rules object a global rule as opposed to a rules comprised of other ContextFilteringRule objects.

getGlobalContextType

public GlobalContextType getGlobalContextType()

copy

public ContextFilteringRules copy()

Returns a deep copy of this object

isEmpty

public boolean isEmpty()

Returns true if there are no ContextFilteringRules rules.

getNumRules

public int getNumRules()

Returns the number of filtering rules.

getRule

public ContextFilteringRule getRule(int pIndex)

Returns the filtering rule at the specified index.

addRule

public void addRule(ContextFilteringRule pContextFilteringRule)

Adds the specified ContextFilteringRule to the end of the list of filtering rules.

removeRule

public void removeRule(ContextFilteringRule pContextFilteringRule)

Removes the filtering rule at the specified index.

toString

public java.lang.String toString(java.lang.String pIndent)

Returns the string representation of the object, indenting the text using the specified pIndent string.

hashCode

public int hashCode()

Return an integer hash code for this object

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

equals

public boolean equals(java.lang.Object obj)

Returns true if the given ContextFilteringRules has same number of elements as this one and each individual ContextFilteringRule object in the given ContextFilteringRules equals (via its equals method) the corresponding ContextFilteringRule in this ContextFilteringRules object. Otherwise, returns false.

Overrides:

equals in class java.lang.Object

filter

public RepositoryItem[] filter(RepositoryItem[] pItems)
                        throws RepositoryException

Filter elements based on context membership property value. Elements not in membership context defined by the ContextFilteringRule associated with this object are removed from the array. Original array is not modified.

Parameters:

pItems -

Returns:

filtered array of repository items

Throws:

RepositoryException

toString

public java.lang.String toString()

Returns the string representation of the object.

Overrides:

toString in class java.lang.Object