com.filenet.wcm.toolkit.server.util.xml
Class XMLPropertiesFilter

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
      extended bycom.filenet.wcm.toolkit.server.util.xml.XMLPropertiesFilter

public class XMLPropertiesFilter
extends WcmDocumentImpl

WcmDocumentImpl derived class for manipulating Property Description specific XML


Field Summary
static java.lang.String ELEM_LABEL
           
static java.lang.String ELEM_LOCALE
           
static java.lang.String ELEM_LOCALIZATIONKEY
           
static java.lang.String ELEM_NAME
           
static java.lang.String ELEM_OBJECT
           
static java.lang.String ELEM_OBJECTSTORE
           
static java.lang.String ELEM_PROPERTIES
           
static java.lang.String ELEM_PROPERTY
           
static java.lang.String ELEM_TYPE
           
static java.lang.String EMPTY_XML
          String represents empty XML response set
static java.lang.String XPATH_OBJECTSTORES
          XPath for a object store
 
Fields inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
ELEM_OBJECTSET, thisDoc
 
Constructor Summary
XMLPropertiesFilter(org.w3c.dom.Document newXML)
          Constructor takes the Property Descriptions Document object
 
Method Summary
 void copyNodeTree(java.lang.String defaultObjectStore, java.lang.String objectStoreName, java.lang.String objectType)
          Copy nodes from default object store setting
 org.w3c.dom.Element createLabel(java.lang.String objectStoreName, java.lang.String type, java.lang.String symName, java.util.Locale locale, java.lang.String displayName)
          Create a label node
 org.w3c.dom.Element createObject(java.lang.String objectStoreName, java.lang.String type)
          Create a object node
 org.w3c.dom.Element createObjectStore(java.lang.String objectStoreName)
          Create a object store node
 org.w3c.dom.Element createProperties(java.lang.String objectStoreName, java.lang.String type)
          Create a properties node
 org.w3c.dom.Element createProperty(java.lang.String objectStoreName, java.lang.String type, java.lang.String symName)
          Create a property node
 java.lang.String getLabel(java.lang.String objectStoreName, java.lang.String type, java.lang.String symName, java.util.Locale locale)
          Returns property label back
static org.w3c.dom.Document getNormalizedDOM()
          return a new created DOM with basic response/objectset in xml
 org.w3c.dom.Element getObject(java.lang.String objectStoreName, java.lang.String type)
          Returns type node back
 org.w3c.dom.Element getObjectStore(java.lang.String objectStoreName)
          Returns object store node back
 org.w3c.dom.Element getObjectStores()
          Object Methods
 org.w3c.dom.Element getProperties(java.lang.String objectStoreName, java.lang.String type)
          Returns properties node back
 org.w3c.dom.Element getProperty(java.lang.String objectStoreName, java.lang.String type, java.lang.String symName)
          Returns property node back
 java.lang.String getPropertyLocalizationKey(java.lang.String objectStoreName, java.lang.String type, java.lang.String symName)
           
 boolean isObjectExist(java.lang.String objectStoreName, java.lang.String type)
          find default object store
 boolean isObjectStoreExist(java.lang.String objectStoreName)
          find default object store
 org.w3c.dom.Element removeLabel(java.lang.String objectStoreName, java.lang.String type, java.lang.String symName, java.util.Locale locale)
          Remove a label node
 void removeObject(java.lang.String objectStoreName, java.lang.String type)
          Remove an object node
protected  void setNodeAttribute(org.w3c.dom.Node node, java.lang.String attrName, java.lang.String attrValue)
          A convenience method for setting the attributes on a given node.
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
createCDATAChildElement, createChildElement, createChildElement, createNamespace, getDocumentImpl, getElement, getElement, getElementText, getNodeList, getThis
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

XPATH_OBJECTSTORES

public static final java.lang.String XPATH_OBJECTSTORES
XPath for a object store

See Also:
Constant Field Values

ELEM_OBJECTSTORE

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

ELEM_OBJECT

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

ELEM_TYPE

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

ELEM_NAME

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

ELEM_PROPERTIES

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

ELEM_PROPERTY

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

ELEM_LABEL

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

ELEM_LOCALE

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

ELEM_LOCALIZATIONKEY

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

EMPTY_XML

public static final java.lang.String EMPTY_XML
String represents empty XML response set

See Also:
Constant Field Values
Constructor Detail

XMLPropertiesFilter

public XMLPropertiesFilter(org.w3c.dom.Document newXML)
Constructor takes the Property Descriptions Document object

Parameters:
newXML - The new Property Descriptions Document object
Method Detail

getObjectStores

public org.w3c.dom.Element getObjectStores()
                                    throws java.lang.Exception
Object Methods

Throws:
java.lang.Exception

isObjectStoreExist

public boolean isObjectStoreExist(java.lang.String objectStoreName)
                           throws java.lang.Exception
find default object store

Returns:
boolean true if default exist, false otherwise.
Throws:
java.lang.Exception

isObjectExist

public boolean isObjectExist(java.lang.String objectStoreName,
                             java.lang.String type)
                      throws java.lang.Exception
find default object store

Returns:
boolean true if default exist, false otherwise.
Throws:
java.lang.Exception

getObjectStore

public org.w3c.dom.Element getObjectStore(java.lang.String objectStoreName)
                                   throws java.lang.Exception
Returns object store node back

Parameters:
objectStoreName - object store name
Returns:
object store node
Throws:
java.lang.Exception

getObject

public org.w3c.dom.Element getObject(java.lang.String objectStoreName,
                                     java.lang.String type)
                              throws java.lang.Exception
Returns type node back

Parameters:
objectStoreName - object store name
type - object type; "document", "folder" or "custom"
Returns:
type node
Throws:
java.lang.Exception

getProperties

public org.w3c.dom.Element getProperties(java.lang.String objectStoreName,
                                         java.lang.String type)
                                  throws java.lang.Exception
Returns properties node back

Parameters:
objectStoreName - object store name
type - object type; "document", "folder" or "custom"
Returns:
properties node
Throws:
java.lang.Exception

getProperty

public org.w3c.dom.Element getProperty(java.lang.String objectStoreName,
                                       java.lang.String type,
                                       java.lang.String symName)
                                throws java.lang.Exception
Returns property node back

Parameters:
objectStoreName - object store name
type - object type; "document", "folder" or "custom"
symName - property symbolic name
Returns:
property node
Throws:
java.lang.Exception

getLabel

public java.lang.String getLabel(java.lang.String objectStoreName,
                                 java.lang.String type,
                                 java.lang.String symName,
                                 java.util.Locale locale)
                          throws java.lang.Exception
Returns property label back

Parameters:
objectStoreName - object store name
type - object type; "document", "folder" or "custom"
symName - property symbolic name
locale - Locale
Returns:
localized label
Throws:
java.lang.Exception

getPropertyLocalizationKey

public java.lang.String getPropertyLocalizationKey(java.lang.String objectStoreName,
                                                   java.lang.String type,
                                                   java.lang.String symName)
                                            throws java.lang.Exception
Throws:
java.lang.Exception

createObjectStore

public org.w3c.dom.Element createObjectStore(java.lang.String objectStoreName)
                                      throws java.lang.Exception
Create a object store node

Parameters:
objectStoreName - object store name
Returns:
new created object store node
Throws:
java.lang.Exception

createObject

public org.w3c.dom.Element createObject(java.lang.String objectStoreName,
                                        java.lang.String type)
                                 throws java.lang.Exception
Create a object node

Parameters:
objectStoreName - object store name
type - object type; "document", "folder" or "custom"
Returns:
object node
Throws:
java.lang.Exception

createProperties

public org.w3c.dom.Element createProperties(java.lang.String objectStoreName,
                                            java.lang.String type)
                                     throws java.lang.Exception
Create a properties node

Parameters:
objectStoreName - object store name
type - object type; "document", "folder" or "custom"
Returns:
properties node
Throws:
java.lang.Exception

createProperty

public org.w3c.dom.Element createProperty(java.lang.String objectStoreName,
                                          java.lang.String type,
                                          java.lang.String symName)
                                   throws java.lang.Exception
Create a property node

Parameters:
objectStoreName - object store name
type - object type; "document", "folder" or "custom"
symName - Property symbolic name
Returns:
property node
Throws:
java.lang.Exception

createLabel

public org.w3c.dom.Element createLabel(java.lang.String objectStoreName,
                                       java.lang.String type,
                                       java.lang.String symName,
                                       java.util.Locale locale,
                                       java.lang.String displayName)
                                throws java.lang.Exception
Create a label node

Parameters:
objectStoreName - object store name
type - object type; "document", "folder" or "custom"
symName - Property symbolic name
locale - Locale
displayName - localized display name
Returns:
label node
Throws:
java.lang.Exception

removeLabel

public org.w3c.dom.Element removeLabel(java.lang.String objectStoreName,
                                       java.lang.String type,
                                       java.lang.String symName,
                                       java.util.Locale locale)
                                throws java.lang.Exception
Remove a label node

Parameters:
objectStoreName - object store name
type - object type; "document", "folder" or "custom"
symName - Property symbolic name
locale - Locale
Returns:
old label node if any
Throws:
java.lang.Exception

removeObject

public void removeObject(java.lang.String objectStoreName,
                         java.lang.String type)
                  throws java.lang.Exception
Remove an object node

Parameters:
objectStoreName - object store name
type - object type; "document", "folder" or "custom"
Throws:
java.lang.Exception

copyNodeTree

public void copyNodeTree(java.lang.String defaultObjectStore,
                         java.lang.String objectStoreName,
                         java.lang.String objectType)
                  throws java.lang.Exception
Copy nodes from default object store setting

Parameters:
objectStoreName - object store name
Throws:
java.lang.Exception

setNodeAttribute

protected void setNodeAttribute(org.w3c.dom.Node node,
                                java.lang.String attrName,
                                java.lang.String attrValue)
A convenience method for setting the attributes on a given node.

Parameters:
node - the node on which the attributes will be set.
attrName - the name of the attribute (doesn't have to exist/can be new)
attrValue - the value to assign to the specified attribute

getNormalizedDOM

public static org.w3c.dom.Document getNormalizedDOM()
                                             throws java.lang.Exception
return a new created DOM with basic response/objectset in xml

Returns:
return a basic Workplace xml.
Throws:
java.lang.Exception


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