com.filenet.wcm.toolkit.server.util
Class FilterData

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.FilterData

public class FilterData
extends java.lang.Object

This helper class is used by WcmNavigationDataProvider and provides XML functions. XML used in NavigationDataProvider getFolderContainees(xml);

The XML that's returned from toString() will look something like:

Dev1 FS my folder name DOCUMENT Creator DocumentTitle Creator typestring eq and Administrator and and DOCUMENT NO and 500


Nested Class Summary
 class FilterData.contentData
           
 class FilterData.filterClassData
           
 class FilterData.filterPropTypeData
           
 
Field Summary
static java.lang.String AND_OP
           
protected static java.lang.String COUNT1_XPATH
          Deprecated.  
static java.lang.String CUSTOM_OBJECT
           
protected static java.lang.String CUSTOM_OJBECT_XPATH
           
static java.lang.String DOCUMENT_OBJECT
           
protected static java.lang.String DOCUMENT_XPATH
           
protected static java.lang.String ELEM_WEB_SEARCH
          Deprecated.  
static java.lang.String EQUAL_OP
           
protected static java.lang.String FILTER_CLAUSE_XPATH
           
protected static java.lang.String FILTER_FOLDERID_XPATH
           
protected static java.lang.String FILTER_INCLUDESUB_XPATH
           
protected static java.lang.String FILTER_OBJECT_STORE_NAME_XPATH
           
static java.lang.String FOLDER_OBJECT
           
protected static java.lang.String FOLDER_XPATH
           
static java.lang.String GT_OP
           
static java.lang.String GT_OR_EQ_OP
           
static java.lang.String IN_OP
           
static java.lang.String IS_NULL_OP
           
static java.lang.String LIKE_OP
           
static java.lang.String LT_OP
           
static java.lang.String LT_OR_EQ_OP
           
static java.lang.String NOT_EQ_OP
           
static java.lang.String NOT_NULL_OP
           
protected static java.lang.String OBJECT_STORE_NAMES_XPATH
          Deprecated.  
static java.lang.String OR_OP
           
static java.lang.String STOREDSEARCH_OBJECT
           
static java.lang.String TYPE_GUID
           
static java.lang.String TYPE_NUMBER
           
static java.lang.String TYPE_OBJECT
           
static java.lang.String TYPE_STRING
           
static java.lang.String TYPE_UNQUOTED
           
 
Constructor Summary
FilterData()
           
FilterData(org.w3c.dom.Document sql)
          Deprecated.  
 
Method Summary
protected static void addFilterData(org.w3c.dom.Node filterClause, FilterData filterData)
           
 void addProp(java.lang.String type, java.lang.String propName, java.lang.String propType, java.lang.String operator, java.lang.String join, java.lang.String value)
           
 void addPropBeginClause(java.lang.String type, java.lang.String propName, java.lang.String propType, java.lang.String operator, java.lang.String join, java.lang.String value)
           
 void addPropEndClause(java.lang.String type, java.lang.String propName, java.lang.String propType, java.lang.String operator, java.lang.String join, java.lang.String value)
           
 void addSelectProp(java.lang.String type, java.lang.String propName)
           
protected static boolean checkParam(java.lang.Object o)
          Make sure object is not null and has some value.
protected  org.w3c.dom.Element createElement(org.w3c.dom.Document doc, java.lang.String name)
           
protected  java.lang.String createLikeString(java.lang.String likeValue)
           
static java.lang.String encodeRank(java.lang.String str)
           
protected  java.lang.String encodeStringSQL(java.lang.String searchString)
           
 org.w3c.dom.Document executeSearch(java.lang.String sql, int type, com.filenet.wcm.api.Session session)
          Executes SQL statement and returns results as a DOM Document.
 java.lang.String executeSearchXML(java.lang.String sql, int type, com.filenet.wcm.api.Session session)
           
 FilterData.contentData getContentData(java.lang.String type)
           
protected  int getCount(org.w3c.dom.Document doc)
          Deprecated.  
 FilterData.filterClassData getFilterClass(java.lang.String type)
           
static FilterData getFilterData(org.w3c.dom.Document sql)
          Deprecated. Factory method returns an instance of this object to use.
 java.util.List getFilterPropCriteria(java.lang.String type)
           
 boolean getFolderIncludeSubfolders()
           
 java.lang.String getFolderName()
           
 int getMaxResults(java.lang.String type)
          Deprecated.  
 int getMaxResultsForObjectType(int objectType)
           
protected static org.w3c.dom.Node getNodeNamed(org.w3c.dom.NodeList nodeList, java.lang.String name)
          Pick a node from a nodeList using using the node's name.
 java.lang.String getObjectStoreName()
           
 java.lang.String getOrderBy(java.lang.String type)
           
 org.w3c.dom.Document getResults(com.filenet.wcm.api.Session session)
           
 org.w3c.dom.Document getResults(com.filenet.wcm.api.Session session, java.util.Map cache, boolean refresh)
           
 java.lang.String[] getSelectProps(int objectType)
           
 java.lang.String[] getSelectProps(java.lang.String type)
           
 boolean getStoreSearchOnly()
           
 boolean getTypeValid(java.lang.String type)
           
protected  java.lang.String makeStatement(int objectType)
           
protected  org.w3c.dom.Document mergeObjectSets(org.w3c.dom.Document set1, org.w3c.dom.Document set2)
          Deprecated. Exclude any folder its class id is not the same as classId.
static java.lang.String parseVerityText(java.lang.String text)
          parseText will segment the text into words, phrases
 int propCount(java.lang.String type)
           
 boolean propInCriteria(java.lang.String type, java.lang.String propName, java.lang.String value)
           
 void setContentData(java.lang.String type, java.lang.String contentstring, java.lang.String join)
           
 void setContentData(java.lang.String type, java.lang.String contentstring, java.lang.String join, java.lang.String searchscope)
           
protected  org.w3c.dom.Document setCount(org.w3c.dom.Document results, int numDocuments, int numFolders, int numCustomObjects)
          Exclude any folder its class id is not the same as classId.
 void setFilterClass(java.lang.String type, java.lang.String classname, java.lang.String join, java.lang.String includesubclasses)
           
 java.util.List setFilterClauseValid(java.lang.String type)
           
 void setFolderIncludeSubfolders(boolean value)
           
 void setFolderName(java.lang.String name)
           
 void setMaxResults(java.lang.String type, java.lang.String maxResults)
           
 void setObjectStoreName(java.lang.String name)
           
 void setOrderBy(java.lang.String type, java.lang.String prop)
           
 void setStoredSearchOnly(boolean value)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

FILTER_OBJECT_STORE_NAME_XPATH

protected static final java.lang.String FILTER_OBJECT_STORE_NAME_XPATH
See Also:
Constant Field Values

FILTER_FOLDERID_XPATH

protected static final java.lang.String FILTER_FOLDERID_XPATH
See Also:
Constant Field Values

FILTER_CLAUSE_XPATH

protected static final java.lang.String FILTER_CLAUSE_XPATH
See Also:
Constant Field Values

FILTER_INCLUDESUB_XPATH

protected static final java.lang.String FILTER_INCLUDESUB_XPATH
See Also:
Constant Field Values

COUNT1_XPATH

protected static final java.lang.String COUNT1_XPATH
Deprecated.  

See Also:
Constant Field Values

FOLDER_XPATH

protected static final java.lang.String FOLDER_XPATH
See Also:
Constant Field Values

CUSTOM_OJBECT_XPATH

protected static final java.lang.String CUSTOM_OJBECT_XPATH
See Also:
Constant Field Values

DOCUMENT_XPATH

protected static final java.lang.String DOCUMENT_XPATH
See Also:
Constant Field Values

OBJECT_STORE_NAMES_XPATH

protected static final java.lang.String OBJECT_STORE_NAMES_XPATH
Deprecated.  

See Also:
Constant Field Values

ELEM_WEB_SEARCH

protected static final java.lang.String ELEM_WEB_SEARCH
Deprecated.  

See Also:
Constant Field Values

DOCUMENT_OBJECT

public static final java.lang.String DOCUMENT_OBJECT
See Also:
Constant Field Values

STOREDSEARCH_OBJECT

public static final java.lang.String STOREDSEARCH_OBJECT
See Also:
Constant Field Values

FOLDER_OBJECT

public static final java.lang.String FOLDER_OBJECT
See Also:
Constant Field Values

CUSTOM_OBJECT

public static final java.lang.String CUSTOM_OBJECT
See Also:
Constant Field Values

AND_OP

public static final java.lang.String AND_OP
See Also:
Constant Field Values

OR_OP

public static final java.lang.String OR_OP
See Also:
Constant Field Values

EQUAL_OP

public static final java.lang.String EQUAL_OP
See Also:
Constant Field Values

LT_OP

public static final java.lang.String LT_OP
See Also:
Constant Field Values

GT_OP

public static final java.lang.String GT_OP
See Also:
Constant Field Values

LT_OR_EQ_OP

public static final java.lang.String LT_OR_EQ_OP
See Also:
Constant Field Values

GT_OR_EQ_OP

public static final java.lang.String GT_OR_EQ_OP
See Also:
Constant Field Values

NOT_NULL_OP

public static final java.lang.String NOT_NULL_OP
See Also:
Constant Field Values

IS_NULL_OP

public static final java.lang.String IS_NULL_OP
See Also:
Constant Field Values

IN_OP

public static final java.lang.String IN_OP
See Also:
Constant Field Values

NOT_EQ_OP

public static final java.lang.String NOT_EQ_OP
See Also:
Constant Field Values

LIKE_OP

public static final java.lang.String LIKE_OP
See Also:
Constant Field Values

TYPE_UNQUOTED

public static final java.lang.String TYPE_UNQUOTED
See Also:
Constant Field Values

TYPE_GUID

public static final java.lang.String TYPE_GUID
See Also:
Constant Field Values

TYPE_NUMBER

public static final java.lang.String TYPE_NUMBER
See Also:
Constant Field Values

TYPE_STRING

public static final java.lang.String TYPE_STRING
See Also:
Constant Field Values

TYPE_OBJECT

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

FilterData

public FilterData()
           throws java.lang.Exception

FilterData

public FilterData(org.w3c.dom.Document sql)
           throws java.lang.Exception
Deprecated.  

Parameters:
sql -
Throws:
java.lang.Exception
Method Detail

setStoredSearchOnly

public void setStoredSearchOnly(boolean value)

getStoreSearchOnly

public boolean getStoreSearchOnly()

checkParam

protected static boolean checkParam(java.lang.Object o)
                             throws java.lang.Exception
Make sure object is not null and has some value. For now it only works with String type.

Parameters:
o - XML object key name.
Returns:
boolean Return true if object is a string and not null.
Throws:
java.lang.Exception - If there are problems retrieving data or with an invalid parameter.

addProp

public void addProp(java.lang.String type,
                    java.lang.String propName,
                    java.lang.String propType,
                    java.lang.String operator,
                    java.lang.String join,
                    java.lang.String value)
             throws java.lang.Exception
Throws:
java.lang.Exception

propInCriteria

public boolean propInCriteria(java.lang.String type,
                              java.lang.String propName,
                              java.lang.String value)

propCount

public int propCount(java.lang.String type)

addPropBeginClause

public void addPropBeginClause(java.lang.String type,
                               java.lang.String propName,
                               java.lang.String propType,
                               java.lang.String operator,
                               java.lang.String join,
                               java.lang.String value)
                        throws java.lang.Exception
Throws:
java.lang.Exception

addPropEndClause

public void addPropEndClause(java.lang.String type,
                             java.lang.String propName,
                             java.lang.String propType,
                             java.lang.String operator,
                             java.lang.String join,
                             java.lang.String value)
                      throws java.lang.Exception
Throws:
java.lang.Exception

setFilterClauseValid

public java.util.List setFilterClauseValid(java.lang.String type)
                                    throws java.lang.Exception
Throws:
java.lang.Exception

getFilterPropCriteria

public java.util.List getFilterPropCriteria(java.lang.String type)

setObjectStoreName

public void setObjectStoreName(java.lang.String name)
                        throws java.lang.Exception
Throws:
java.lang.Exception

setFolderName

public void setFolderName(java.lang.String name)
                   throws java.lang.Exception
Throws:
java.lang.Exception

setFolderIncludeSubfolders

public void setFolderIncludeSubfolders(boolean value)

getFolderIncludeSubfolders

public boolean getFolderIncludeSubfolders()

getFolderName

public java.lang.String getFolderName()

getObjectStoreName

public java.lang.String getObjectStoreName()

setFilterClass

public void setFilterClass(java.lang.String type,
                           java.lang.String classname,
                           java.lang.String join,
                           java.lang.String includesubclasses)
                    throws java.lang.Exception
Throws:
java.lang.Exception

setOrderBy

public void setOrderBy(java.lang.String type,
                       java.lang.String prop)
                throws java.lang.Exception
Throws:
java.lang.Exception

getFilterClass

public FilterData.filterClassData getFilterClass(java.lang.String type)

getOrderBy

public java.lang.String getOrderBy(java.lang.String type)

setContentData

public void setContentData(java.lang.String type,
                           java.lang.String contentstring,
                           java.lang.String join,
                           java.lang.String searchscope)
                    throws java.lang.Exception
Throws:
java.lang.Exception

setContentData

public void setContentData(java.lang.String type,
                           java.lang.String contentstring,
                           java.lang.String join)
                    throws java.lang.Exception
Throws:
java.lang.Exception

getContentData

public FilterData.contentData getContentData(java.lang.String type)

addSelectProp

public void addSelectProp(java.lang.String type,
                          java.lang.String propName)
                   throws java.lang.Exception
Throws:
java.lang.Exception

getSelectProps

public java.lang.String[] getSelectProps(int objectType)

getSelectProps

public java.lang.String[] getSelectProps(java.lang.String type)

setMaxResults

public void setMaxResults(java.lang.String type,
                          java.lang.String maxResults)
                   throws java.lang.Exception
Throws:
java.lang.Exception

getMaxResultsForObjectType

public int getMaxResultsForObjectType(int objectType)

getMaxResults

public int getMaxResults(java.lang.String type)
Deprecated.  

Parameters:
type -
Returns:
max results

getTypeValid

public boolean getTypeValid(java.lang.String type)

toString

public java.lang.String toString()

makeStatement

protected java.lang.String makeStatement(int objectType)
                                  throws java.lang.Exception
Throws:
java.lang.Exception

createLikeString

protected java.lang.String createLikeString(java.lang.String likeValue)
                                     throws java.lang.Exception
Throws:
java.lang.Exception

encodeStringSQL

protected java.lang.String encodeStringSQL(java.lang.String searchString)
                                    throws java.lang.Exception
Throws:
java.lang.Exception

mergeObjectSets

protected org.w3c.dom.Document mergeObjectSets(org.w3c.dom.Document set1,
                                               org.w3c.dom.Document set2)
                                        throws java.lang.Exception
Deprecated. Exclude any folder its class id is not the same as classId.

Returns:
Filtered folders DOM object
Throws:
java.lang.Exception

createElement

protected org.w3c.dom.Element createElement(org.w3c.dom.Document doc,
                                            java.lang.String name)

setCount

protected org.w3c.dom.Document setCount(org.w3c.dom.Document results,
                                        int numDocuments,
                                        int numFolders,
                                        int numCustomObjects)
                                 throws java.lang.Exception
Exclude any folder its class id is not the same as classId.

Returns:
Filtered folders DOM object
Throws:
java.lang.Exception

getCount

protected int getCount(org.w3c.dom.Document doc)
                throws java.lang.Exception
Deprecated.  

Parameters:
doc -
Returns:
Throws:
java.lang.Exception

executeSearch

public org.w3c.dom.Document executeSearch(java.lang.String sql,
                                          int type,
                                          com.filenet.wcm.api.Session session)
                                   throws java.lang.Exception
Executes SQL statement and returns results as a DOM Document. No caching is done by tihs method.

Parameters:
sql - SQL Statement
Returns:
XML Document with the results in ADO format
Throws:
java.lang.Exception - If there are problems executing the query

executeSearchXML

public java.lang.String executeSearchXML(java.lang.String sql,
                                         int type,
                                         com.filenet.wcm.api.Session session)
                                  throws java.lang.Exception
Throws:
java.lang.Exception

getResults

public org.w3c.dom.Document getResults(com.filenet.wcm.api.Session session,
                                       java.util.Map cache,
                                       boolean refresh)
                                throws java.lang.Exception
Throws:
java.lang.Exception

getResults

public org.w3c.dom.Document getResults(com.filenet.wcm.api.Session session)
                                throws java.lang.Exception
Throws:
java.lang.Exception

getFilterData

public static FilterData getFilterData(org.w3c.dom.Document sql)
                                throws java.lang.Exception
Deprecated. Factory method returns an instance of this object to use.

Returns:
New instance of FilterData object
Throws:
java.lang.Exception - If any errors occured

addFilterData

protected static void addFilterData(org.w3c.dom.Node filterClause,
                                    FilterData filterData)
                             throws java.lang.Exception
Throws:
java.lang.Exception

parseVerityText

public static java.lang.String parseVerityText(java.lang.String text)
                                        throws java.lang.Exception
parseText will segment the text into words, phrases

Parameters:
text - the text to parse... a direct pass thru from the parse() method.
Throws:
java.lang.Exception

encodeRank

public static java.lang.String encodeRank(java.lang.String str)

getNodeNamed

protected static org.w3c.dom.Node getNodeNamed(org.w3c.dom.NodeList nodeList,
                                               java.lang.String name)
Pick a node from a nodeList using using the node's name.



© Copyright IBM Corp. 2002, 2007. All Rights Reserved.