com.plumtree.portaluiinfrastructure.filter
Class FilterIterator

java.lang.Object
  extended by com.plumtree.portaluiinfrastructure.filter.FilterIterator
All Implemented Interfaces:
IFilterIteratorRO, IModelRO, IMVCObject

public class FilterIterator
extends java.lang.Object
implements IFilterIteratorRO

Author:
CraigS, based on MikeS code

Field Summary
static java.lang.String STR_MVC_CLASS_NAME
           
 
Constructor Summary
FilterIterator(IPTSession session, IPTFilter filter, AActivitySpace owner)
          Creates a new FilterIterator object.
 
Method Summary
 boolean AddSetProperty(QueryCondition qc)
           
 int GetCurrentClauseDepth()
          Gets the depth of the current clause.
 boolean GetCurrentClauseOperator()
          Gets the operator (AND or OR) that joins the current clause together.
 java.lang.String GetName()
          Return the name of the MVC object.
 boolean GetNextClausePosition()
           
 IPTPropertyFilterStatement GetNextStatement()
           
 boolean GetNextStatementAndSetQC(QueryCondition qc)
           
 int GetNumItemsInFirstClause()
          Convenience method to return the number of items in the first clause; basically an easy way to see if this filter contains anything of interest
 IASQueryResult GetPropertiesVisibleToCurrentUser()
          Queries the database for the set of properties this user can see (on the first call), returns a cached value on subsequent calls.
 java.lang.String GetTextSearchString()
          Gets the filter's top-level search string.
 boolean GetTopLevelAllMustPass()
           
 void InitFromFilter(IPTFilter filter)
           
 QueryCondition MakeQueryCondition()
          Manufactures a QueryCondition
 void SetAllowablePropertyIDs(java.lang.Object[] iArAllowablePropertyIDs)
          Allows the Filter Iterator to only show those properties specified.
 void SetIncludeGroupMembership(boolean bIncludeMembership)
           
 void SetIteratorToStart()
          Resets this iterator to the beginning.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME
See Also:
Constant Field Values
Constructor Detail

FilterIterator

public FilterIterator(IPTSession session,
                      IPTFilter filter,
                      AActivitySpace owner)
Creates a new FilterIterator object.

Parameters:
session -
filter -
owner -
Method Detail

MakeQueryCondition

public QueryCondition MakeQueryCondition()
Manufactures a QueryCondition

Specified by:
MakeQueryCondition in interface IFilterIteratorRO
Returns:
a QueryCondition

GetCurrentClauseDepth

public int GetCurrentClauseDepth()
Description copied from interface: IFilterIteratorRO
Gets the depth of the current clause.

Specified by:
GetCurrentClauseDepth in interface IFilterIteratorRO
Returns:

GetCurrentClauseOperator

public boolean GetCurrentClauseOperator()
Description copied from interface: IFilterIteratorRO
Gets the operator (AND or OR) that joins the current clause together.

Specified by:
GetCurrentClauseOperator in interface IFilterIteratorRO
Returns:

GetTextSearchString

public java.lang.String GetTextSearchString()
Gets the filter's top-level search string.

Specified by:
GetTextSearchString in interface IFilterIteratorRO
Returns:
the search string

GetName

public java.lang.String GetName()
Description copied from interface: IMVCObject
Return the name of the MVC object.

Specified by:
GetName in interface IMVCObject
Returns:

GetNextClausePosition

public boolean GetNextClausePosition()
Specified by:
GetNextClausePosition in interface IFilterIteratorRO
Returns:

GetNextStatement

public IPTPropertyFilterStatement GetNextStatement()
Returns:

GetNextStatementAndSetQC

public boolean GetNextStatementAndSetQC(QueryCondition qc)
Specified by:
GetNextStatementAndSetQC in interface IFilterIteratorRO
Parameters:
qc -
Returns:

AddSetProperty

public boolean AddSetProperty(QueryCondition qc)
Specified by:
AddSetProperty in interface IFilterIteratorRO
Returns:

GetNumItemsInFirstClause

public int GetNumItemsInFirstClause()
Description copied from interface: IFilterIteratorRO
Convenience method to return the number of items in the first clause; basically an easy way to see if this filter contains anything of interest

Specified by:
GetNumItemsInFirstClause in interface IFilterIteratorRO
Returns:

GetPropertiesVisibleToCurrentUser

public IASQueryResult GetPropertiesVisibleToCurrentUser()
Description copied from interface: IFilterIteratorRO
Queries the database for the set of properties this user can see (on the first call), returns a cached value on subsequent calls.

Specified by:
GetPropertiesVisibleToCurrentUser in interface IFilterIteratorRO
Returns:

GetTopLevelAllMustPass

public boolean GetTopLevelAllMustPass()
Specified by:
GetTopLevelAllMustPass in interface IFilterIteratorRO
Returns:

InitFromFilter

public void InitFromFilter(IPTFilter filter)
Parameters:
filter -

SetIteratorToStart

public void SetIteratorToStart()
Description copied from interface: IFilterIteratorRO
Resets this iterator to the beginning.

Specified by:
SetIteratorToStart in interface IFilterIteratorRO

SetAllowablePropertyIDs

public void SetAllowablePropertyIDs(java.lang.Object[] iArAllowablePropertyIDs)
Allows the Filter Iterator to only show those properties specified. Default behavior is to show all properties the current user has access to.

Parameters:
iArAllowablePropertyIDs - - an array of allowed property ids as Integers. pass in a null array to allow all properties (default)

SetIncludeGroupMembership

public void SetIncludeGroupMembership(boolean bIncludeMembership)



Copyright 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.