com.filenet.wcm.apps.server.util
Class WPRMUtil

java.lang.Object
  extended bycom.filenet.wcm.apps.server.util.WPRMUtil
Direct Known Subclasses:
CategoryUtil

public class WPRMUtil
extends java.lang.Object


Field Summary
protected static java.lang.String COMMON_QUERY
           
protected static java.lang.String LOCATION_CONTAINER
           
protected static java.lang.String VOLUME_QUERY
           
 
Constructor Summary
WPRMUtil()
           
 
Method Summary
static java.lang.String constructTargetUrl(javax.servlet.http.HttpServletRequest request)
          Construct a target URL without event target, name, and url from url paramters
static void copyClassifications(org.w3c.dom.Document domTarget, org.w3c.dom.Document domSource)
          copy classifications from source to target
static org.w3c.dom.Document copySelectedFolders(java.util.List folderList, org.w3c.dom.Document domDest, org.w3c.dom.Document domSource)
          This method copy folders from domSource to domDest.
static java.lang.String findLocationContainer(org.w3c.dom.Document domFolder)
          return the location container folder id
static java.util.List getCheckboxList(javax.servlet.http.HttpServletRequest request, java.lang.String checkBoxName)
          return list of folders where its checkbox is turned on
static int getClassificationCount(org.w3c.dom.Document domSource)
          Return classification count.
static java.lang.String[] getClassifications(org.w3c.dom.Document domSource)
          return classifications in string array
static org.w3c.dom.Document getClassifications(com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider ndp, org.w3c.dom.Document domClassification, java.lang.String objectStoreName, java.lang.String folderIds, java.lang.String[] rmProperties)
          return the classifications object back in term of Workplace required format.
static org.w3c.dom.Document getEmptyDOMObject()
          Return a Document object that contains an empty objectset.
static java.lang.String getFilePlans(org.w3c.dom.Document domSource)
          Return distinct file plan name.
static java.lang.reflect.Method getMethod(java.lang.Object ui, java.lang.String methodName, java.lang.Class[] parameters)
          Return required Method object back.
static java.lang.String getUnqualifyNames(java.lang.String[] selectedIds, java.util.List allIds, org.w3c.dom.Document domSource, java.lang.String fieldName)
           
static org.w3c.dom.Document markSelectedFolders(java.util.List folderList, org.w3c.dom.Document domSource, boolean on)
          select or unselected folder in list
static java.lang.String prepareFolderContentSQLStatement(java.lang.String objectStoreName, java.lang.String[] props, java.lang.String folderPath, int entityType)
          this method return folder query statement that retrieve folder contents from folderPath name value where its container type equal to RECORDCATEGORY or RECORDFOLDER.
static java.lang.String prepareFolderSQLStatement(java.lang.String objectStoreName, java.lang.String[] props, java.lang.String[] folders, int entityType)
          Return folder serarching query statement back.
static java.lang.String prepareFolderSQLStatement(java.lang.String objectStoreName, java.lang.String[] props, java.lang.String searchOperator, java.lang.String searchText, java.lang.String[] searchFieldNames, int entityType)
          this method return folder query statement that searching for folder property with certain value
protected static java.lang.String preparePropertyStatement(java.lang.String prefix, java.lang.String[] props)
          This method return query request property statement back with default of isHiddenContainer
protected static java.lang.String prepareWhereClause(java.lang.String prefix, java.lang.String[] folderIds, int entityType)
          This method return folders query where clause back with default condition of IsHiddenContainer = false
protected static java.lang.String prepareWhereClause(java.lang.String prefix, java.lang.String folderPath, int entityType)
          This method return folders query where clause back with default condition of IsHiddenContainer = false
protected static java.lang.String prepareWhereClause(java.lang.String prefix, java.lang.String searchOperator, java.lang.String searchText, java.lang.String[] searchFieldNames, int entityType)
          This method return folders query where clause back with default condition of IsHiddenContainer = false
static org.w3c.dom.Document removeFolder(java.util.List folderList, org.w3c.dom.Document domFolder)
          Remove folders from Folder dom object.
static org.w3c.dom.Document removeFolder(java.lang.String id, org.w3c.dom.Document domFolder)
          Remove folder from Folder dom object.
static java.lang.String[] sortClassification(java.lang.String[] folders, java.lang.String primaryClassificationId)
           
static java.lang.String[] transformToStringArray(java.util.List ids)
           
static java.lang.String[] transformToStringArray(java.lang.String ids)
           
static org.w3c.dom.Document updateRecordProperties(org.w3c.dom.Document srcXMLProperties, org.w3c.dom.Document srcXMLPropDescs, org.w3c.dom.Document dstXMLProperties, org.w3c.dom.Document dstXMLPropDescs, java.lang.String objectStoreName, java.lang.String classId, java.lang.String className)
          Copy document properties to record properties if it has same synmane or alias
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOCATION_CONTAINER

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

COMMON_QUERY

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

VOLUME_QUERY

protected static final java.lang.String VOLUME_QUERY
See Also:
Constant Field Values
Constructor Detail

WPRMUtil

public WPRMUtil()
Method Detail

getEmptyDOMObject

public static org.w3c.dom.Document getEmptyDOMObject()
                                              throws java.lang.Exception
Return a Document object that contains an empty objectset.

Returns:
Document Object that represents an empty set
Throws:
java.lang.Exception

removeFolder

public static org.w3c.dom.Document removeFolder(java.util.List folderList,
                                                org.w3c.dom.Document domFolder)
                                         throws java.lang.Exception
Remove folders from Folder dom object.

Parameters:
folderList - A list of folder id.
domFolder - Folder DOM object
Returns:
Purged Document Object
Throws:
java.lang.Exception

findLocationContainer

public static java.lang.String findLocationContainer(org.w3c.dom.Document domFolder)
                                              throws java.lang.Exception
return the location container folder id

Parameters:
domFolder - folders xml
Returns:
Throws:
java.lang.Exception

removeFolder

public static org.w3c.dom.Document removeFolder(java.lang.String id,
                                                org.w3c.dom.Document domFolder)
                                         throws java.lang.Exception
Remove folder from Folder dom object.

Parameters:
id - Folder id.
domFolder - Folder DOM object
Returns:
Purged Document Object
Throws:
java.lang.Exception

copySelectedFolders

public static org.w3c.dom.Document copySelectedFolders(java.util.List folderList,
                                                       org.w3c.dom.Document domDest,
                                                       org.w3c.dom.Document domSource)
                                                throws java.lang.Exception
This method copy folders from domSource to domDest. Any folder id appear in list will be copy over

Parameters:
folderList - Ready to be copied folder id list.
domDest - Destination folders dom object
domSource - Source folders dom object
Returns:
merged folder dom object
Throws:
java.lang.Exception

markSelectedFolders

public static org.w3c.dom.Document markSelectedFolders(java.util.List folderList,
                                                       org.w3c.dom.Document domSource,
                                                       boolean on)
                                                throws java.lang.Exception
select or unselected folder in list

Parameters:
folderList - folder id list.
domSource - Source folders dom object
Returns:
Marked folder DOM object
Throws:
java.lang.Exception

getMethod

public static java.lang.reflect.Method getMethod(java.lang.Object ui,
                                                 java.lang.String methodName,
                                                 java.lang.Class[] parameters)
Return required Method object back. If method is not found return null back.

Parameters:
ui - Target object
methodName - Method name
parameters - Method parameters list.
Returns:
Method Object back if found, null otherwise.

constructTargetUrl

public static java.lang.String constructTargetUrl(javax.servlet.http.HttpServletRequest request)
                                           throws java.lang.Exception
Construct a target URL without event target, name, and url from url paramters

Parameters:
request - Http Request object
Returns:
String a url
Throws:
java.lang.Exception

preparePropertyStatement

protected static java.lang.String preparePropertyStatement(java.lang.String prefix,
                                                           java.lang.String[] props)
This method return query request property statement back with default of isHiddenContainer

Parameters:
prefix - table alias
props - a list of property
Returns:
query properties statement.

prepareWhereClause

protected static java.lang.String prepareWhereClause(java.lang.String prefix,
                                                     java.lang.String[] folderIds,
                                                     int entityType)
This method return folders query where clause back with default condition of IsHiddenContainer = false

Parameters:
prefix - table alias
folderIds - A list folder id
Returns:
query where statement

prepareWhereClause

protected static java.lang.String prepareWhereClause(java.lang.String prefix,
                                                     java.lang.String searchOperator,
                                                     java.lang.String searchText,
                                                     java.lang.String[] searchFieldNames,
                                                     int entityType)
This method return folders query where clause back with default condition of IsHiddenContainer = false

Parameters:
prefix - table alias
searchOperator - comparison operation
searchText - searching text.
Returns:
query where clause

prepareWhereClause

protected static java.lang.String prepareWhereClause(java.lang.String prefix,
                                                     java.lang.String folderPath,
                                                     int entityType)
This method return folders query where clause back with default condition of IsHiddenContainer = false

Parameters:
prefix - table alias
folderPath - folder path.
Returns:
query where clause

prepareFolderSQLStatement

public static java.lang.String prepareFolderSQLStatement(java.lang.String objectStoreName,
                                                         java.lang.String[] props,
                                                         java.lang.String[] folders,
                                                         int entityType)
Return folder serarching query statement back.

Parameters:
objectStoreName - object store name
props - required properties
folders - a list of folder id
Returns:
folder query statement

prepareFolderSQLStatement

public static java.lang.String prepareFolderSQLStatement(java.lang.String objectStoreName,
                                                         java.lang.String[] props,
                                                         java.lang.String searchOperator,
                                                         java.lang.String searchText,
                                                         java.lang.String[] searchFieldNames,
                                                         int entityType)
this method return folder query statement that searching for folder property with certain value

Parameters:
objectStoreName - object store name
props - properties list
searchOperator - comparison operator
searchText - searching value
Returns:
folder query statement

prepareFolderContentSQLStatement

public static java.lang.String prepareFolderContentSQLStatement(java.lang.String objectStoreName,
                                                                java.lang.String[] props,
                                                                java.lang.String folderPath,
                                                                int entityType)
this method return folder query statement that retrieve folder contents from folderPath name value where its container type equal to RECORDCATEGORY or RECORDFOLDER.

Parameters:
objectStoreName - object store name
props - properties list
folderPath - folder path ie. a/b/c
Returns:
folder query statement

getCheckboxList

public static java.util.List getCheckboxList(javax.servlet.http.HttpServletRequest request,
                                             java.lang.String checkBoxName)
return list of folders where its checkbox is turned on

Parameters:
request - HttpRequest
checkBoxName - Checkbox name
Returns:
folders id list

getClassificationCount

public static int getClassificationCount(org.w3c.dom.Document domSource)
                                  throws java.lang.Exception
Return classification count.

Parameters:
domSource - Classification DOM object
Returns:
How many classification in object.
Throws:
java.lang.Exception

getFilePlans

public static java.lang.String getFilePlans(org.w3c.dom.Document domSource)
                                     throws java.lang.Exception
Return distinct file plan name.

Parameters:
domSource - Classification DOM object
Returns:
How many classification in object.
Throws:
java.lang.Exception

transformToStringArray

public static java.lang.String[] transformToStringArray(java.lang.String ids)

transformToStringArray

public static java.lang.String[] transformToStringArray(java.util.List ids)

getClassifications

public static java.lang.String[] getClassifications(org.w3c.dom.Document domSource)
                                             throws java.lang.Exception
return classifications in string array

Parameters:
domSource -
Returns:
string array of classification id
Throws:
java.lang.Exception

copyClassifications

public static void copyClassifications(org.w3c.dom.Document domTarget,
                                       org.w3c.dom.Document domSource)
                                throws java.lang.Exception
copy classifications from source to target

Parameters:
domSource - Source
domTarget - Target
Throws:
java.lang.Exception

getUnqualifyNames

public static java.lang.String getUnqualifyNames(java.lang.String[] selectedIds,
                                                 java.util.List allIds,
                                                 org.w3c.dom.Document domSource,
                                                 java.lang.String fieldName)
                                          throws java.lang.Exception
Throws:
java.lang.Exception

getClassifications

public static org.w3c.dom.Document getClassifications(com.filenet.wcm.toolkit.server.dp.WcmNavigationDataProvider ndp,
                                                      org.w3c.dom.Document domClassification,
                                                      java.lang.String objectStoreName,
                                                      java.lang.String folderIds,
                                                      java.lang.String[] rmProperties)
                                               throws java.lang.Exception
return the classifications object back in term of Workplace required format. This methods use input parameter, ndp to execute a serch retrieveing required properties from content server for ui display purpose

Parameters:
ndp - WcmNavigationDataProvider
Returns:
Classifications XML in DOM Format.
Throws:
java.lang.Exception

updateRecordProperties

public static org.w3c.dom.Document updateRecordProperties(org.w3c.dom.Document srcXMLProperties,
                                                          org.w3c.dom.Document srcXMLPropDescs,
                                                          org.w3c.dom.Document dstXMLProperties,
                                                          org.w3c.dom.Document dstXMLPropDescs,
                                                          java.lang.String objectStoreName,
                                                          java.lang.String classId,
                                                          java.lang.String className)
                                                   throws java.lang.Exception
Copy document properties to record properties if it has same synmane or alias

Parameters:
srcXMLProperties - Document properties
srcXMLPropDescs - Document property descriptions
dstXMLProperties - Record properties
dstXMLPropDescs - Record class property descriptions
Returns:
Copied record properties
Throws:
java.lang.Exception

sortClassification

public static java.lang.String[] sortClassification(java.lang.String[] folders,
                                                    java.lang.String primaryClassificationId)
                                             throws java.lang.Exception
Throws:
java.lang.Exception


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