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

java.lang.Object
  extended bycom.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
      extended bycom.filenet.wcm.toolkit.server.util.xml.WcmXMLObject
          extended bycom.filenet.wcm.toolkit.server.util.xml.WcmXMLProperties
              extended bycom.filenet.wcm.toolkit.server.util.xml.XMLLinks

public class XMLLinks
extends WcmXMLProperties

WcmXMLProperties derived class for manipulating the Link specific XML


Field Summary
static java.lang.String ELEM_LINK
           
 
Fields inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLProperties
ELEM_PROPERTY
 
Fields inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLObject
ELEM_CLASSID, ELEM_CLASSNAME, ELEM_OBJECT, ELEM_OBJECTSTORE
 
Fields inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmDocumentImpl
ELEM_OBJECTSET, thisDoc
 
Method Summary
 org.w3c.dom.Document getClasses(org.w3c.dom.Document allClasses, java.lang.String[] desiredClasses, java.lang.String allLinks)
          Deprecated. use getClasses with additional parameter of allLinksLabel instead. The additional parameter is for localizeation where all links needs to display in user's locale format.
 org.w3c.dom.Document getClasses(org.w3c.dom.Document allClasses, java.lang.String[] desiredClasses, java.lang.String allLinks, java.lang.String allLinksLabel)
          Return Link classes XML which contains all link classes of the specified desired classes
 java.lang.String[] getClassIds(java.lang.String[] otherClasses)
          Get the IDs of all link classes and append to passed in list
static XMLLinks getXMLLinks()
          Get method returns a new instance of this object.
static XMLLinks getXMLLinks(org.w3c.dom.Document newXMLLinks)
          get method creates or contains the Document as one of this type
static org.w3c.dom.Document mergeLinks(org.w3c.dom.Document headLinks, org.w3c.dom.Document tailLinks)
          Merge the head and tail links and return the result.
 void removeProperties()
          Remove all properties except the Head and Tail properties
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLProperties
addMultiObjectValues, addMultiValues, addMultiValues, createComponentRelationshipElement, createCustomObjectElement, createDocumentElement, createFolderElement, createLinkElement, createPropertiesElement, createPropertyElement, createPropertyElement, createPropertyElement, createPropertyElement, getComponentRelationship, getCustomObject, getDocument, getFolder, getLink, getPropertiesElement, getPropertyByID, getPropertyByID, getPropertyByName, getPropertyByName, getPropertySymnameById, getPropertyValueByID, getPropertyValueByName, getPropertyValueByName, getPropertyValueIdByName, getXMLProperties, getXMLProperties, removeAllPropValues, removeObjectValuesByName, removePropertyByName, removePropValues, removeValuesByName, removeValuesByName, setObjectElement, setObjectElement, setPropertyByID, setPropertyByName, setPropertyByName, setPropertyElement
 
Methods inherited from class com.filenet.wcm.toolkit.server.util.xml.WcmXMLObject
getClassdescElement, getClassId, getClassName, getObjectElement, getObjectId, getObjectStoreElement, getObjectStoreId, getObjectTagValue, getObjectXPath, getXMLObject, getXMLObject, setClassDescription, setObjectStoreId, setObjectTagValue, setObjectXPath
 
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

ELEM_LINK

public static final java.lang.String ELEM_LINK
See Also:
Constant Field Values
Method Detail

getXMLLinks

public static XMLLinks getXMLLinks()
                            throws java.lang.Exception
Get method returns a new instance of this object. Also adds the document node.

Returns:
XMLLinks The new XMLLinks object
Throws:
java.lang.Exception - on error

getXMLLinks

public static XMLLinks getXMLLinks(org.w3c.dom.Document newXMLLinks)
                            throws java.lang.Exception
get method creates or contains the Document as one of this type

Parameters:
newXMLLinks - The Document to contain
Returns:
XMLLinks The new XMLLinks object
Throws:
java.lang.Exception - on error

removeProperties

public void removeProperties()
                      throws java.lang.Exception
Remove all properties except the Head and Tail properties

Overrides:
removeProperties in class WcmXMLProperties
Throws:
java.lang.Exception - on error

getClasses

public org.w3c.dom.Document getClasses(org.w3c.dom.Document allClasses,
                                       java.lang.String[] desiredClasses,
                                       java.lang.String allLinks)
                                throws java.lang.Exception
Deprecated. use getClasses with additional parameter of allLinksLabel instead. The additional parameter is for localizeation where all links needs to display in user's locale format.

Return Link classes XML which contains all link classes of the specified desired classes

Parameters:
allClasses - XML that contains all link classes
desiredClasses - Array of classes to add to the link classes XML returned
allLinks - String to use in the for selecting all links
Returns:
Link classes XML of
Throws:
java.lang.Exception - on error

getClasses

public org.w3c.dom.Document getClasses(org.w3c.dom.Document allClasses,
                                       java.lang.String[] desiredClasses,
                                       java.lang.String allLinks,
                                       java.lang.String allLinksLabel)
                                throws java.lang.Exception
Return Link classes XML which contains all link classes of the specified desired classes

Parameters:
allClasses - XML that contains all link classes
desiredClasses - Array of classes to add to the link classes XML returned
allLinks - String to use in the for selecting all links
Returns:
Link classes XML of
Throws:
java.lang.Exception - on error

getClassIds

public java.lang.String[] getClassIds(java.lang.String[] otherClasses)
                               throws java.lang.Exception
Get the IDs of all link classes and append to passed in list

Parameters:
otherClasses - Classes found in other XML
Returns:
List of used link classes
Throws:
java.lang.Exception - on error

mergeLinks

public static org.w3c.dom.Document mergeLinks(org.w3c.dom.Document headLinks,
                                              org.w3c.dom.Document tailLinks)
                                       throws java.lang.Exception
Merge the head and tail links and return the result. Also adds attributes to link tag specifying head or tail linktype.

Parameters:
headLinks - The XML containing Headlinks
tailLinks - The XML containing Taillinks
Returns:
The merged XML
Throws:
java.lang.Exception - on error


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