org.olat.ims.cp.objects
Class CPResources

java.lang.Object
  org.dom4j.tree.AbstractNode
      org.dom4j.tree.AbstractBranch
          org.dom4j.tree.AbstractElement
              org.dom4j.tree.DefaultElement
                  org.olat.ims.cp.objects.CPResources

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.dom4j.Branch, org.dom4j.Element, org.dom4j.Node, CPNode

public class CPResources
extends org.dom4j.tree.DefaultElement
implements CPNode

Description:
This class represents a resources-element of a IMS-manifest-file

Initial Date: 26.06.2008

Author:

sergio

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.dom4j.Node

ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE

Constructor Summary

CPResources()
this constructor is used when creating a new CP

CPResources(org.dom4j.tree.DefaultElement me)
this constructor i used when building up the cp (parsing XML manifest)

Method Summary

void	addResource(CPResource newResource) Adds a new Resouce - element to the end of the resources-vector
void	buildChildren() traverses XML-nodes and builds children-objects this function is invoked while the CP is instantiating (parsing-process of the manifest-file)
void	buildDocument(org.dom4j.tree.DefaultElement parent) generates a DefaultElement with all its Attributes and children, and adds it to parent This Function is needed to build the DefaultDocument of the ContentPackage
java.util.Vector<CPDependency>	getAllDependencies() returns all dependencies (CPDependency) in a vector
java.util.Vector<CPFile>	getAllFiles() returns all files (CPFile) in a vector
org.dom4j.tree.DefaultElement	getElementByIdentifier(java.lang.String id)
CPManifest	getParentElement()
int	getPosition()
CPResource	getResourceByID(java.lang.String identifier) Returns the Resource with the specified identifier Returns null if Resource is not found
java.util.Iterator<CPResource>	getResourceIterator()
java.util.Vector<CPResource>	getResources()
VFSContainer	getRootDir()
void	removeChild(java.lang.String id) removes a child-resource from this elements resource-collection
void	setParentElement(CPManifest parent)
void	setPosition(int pos)
boolean	validateElement() checks whether required attributes are set, and whether required child-elements are present

Methods inherited from class org.dom4j.tree.DefaultElement

add, additionalNamespaces, additionalNamespaces, attribute, attribute, attribute, attribute, attributeCount, attributeIterator, attributes, clearContent, clone, declaredNamespaces, element, element, element, getDocument, getNamespaceForPrefix, getNamespaceForURI, getParent, getQName, getStringValue, getText, indexOf, node, nodeCount, nodeIterator, processingInstruction, processingInstructions, processingInstructions, remove, removeProcessingInstruction, setAttributes, setContent, setDocument, setParent, setQName, supportsParent

Methods inherited from class org.dom4j.tree.AbstractElement

accept, add, add, add, add, add, add, add, add, addAttribute, addAttribute, addCDATA, addComment, addElement, addEntity, addNamespace, addProcessingInstruction, addProcessingInstruction, addText, appendAttributes, asXML, attributeValue, attributeValue, attributeValue, attributeValue, createCopy, createCopy, createCopy, elementIterator, elementIterator, elementIterator, elementIterator, elements, elements, elements, elements, elementText, elementText, elementTextTrim, elementTextTrim, ensureAttributesCapacity, getData, getName, getNamespace, getNamespacePrefix, getNamespacesForURI, getNamespaceURI, getNodeType, getPath, getQName, getQualifiedName, getUniquePath, getXPathNameStep, getXPathResult, hasMixedContent, isRootElement, isTextOnly, normalize, remove, remove, remove, remove, remove, remove, remove, remove, setAttributes, setAttributeValue, setAttributeValue, setData, setName, setNamespace, setText, toString, write

Methods inherited from class org.dom4j.tree.AbstractBranch

addElement, addElement, addElement, appendContent, content, elementByID, getTextTrim, hasContent, isReadOnly, setProcessingInstructions

Methods inherited from class org.dom4j.tree.AbstractNode

asXPathResult, createPattern, createXPath, createXPathFilter, detach, getNodeTypeName, getPath, getUniquePath, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, valueOf

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.dom4j.Element

getTextTrim

Methods inherited from interface org.dom4j.Branch

addElement, addElement, appendContent, content, elementByID, setProcessingInstructions

Methods inherited from interface org.dom4j.Node

asXPathResult, createXPath, detach, getNodeTypeName, getPath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, valueOf

Constructor Detail

CPResources

public CPResources(org.dom4j.tree.DefaultElement me)

this constructor i used when building up the cp (parsing XML manifest)

Parameters:

me -

CPResources

public CPResources()

this constructor is used when creating a new CP

Method Detail

buildChildren

public void buildChildren()

Description copied from interface: CPNode

traverses XML-nodes and builds children-objects this function is invoked while the CP is instantiating (parsing-process of the manifest-file)

Specified by:

buildChildren in interface CPNode

See Also:

CPNode.buildChildren()

validateElement

public boolean validateElement()

Description copied from interface: CPNode

checks whether required attributes are set, and whether required child-elements are present

Specified by:

validateElement in interface CPNode

See Also:

CPNode.validateElement()

buildDocument

public void buildDocument(org.dom4j.tree.DefaultElement parent)

Description copied from interface: CPNode

generates a DefaultElement with all its Attributes and children, and adds it to parent This Function is needed to build the DefaultDocument of the ContentPackage

Specified by:

buildDocument in interface CPNode

addResource

public void addResource(CPResource newResource)

Adds a new Resouce - element to the end of the resources-vector

removeChild

public void removeChild(java.lang.String id)

removes a child-resource from this elements resource-collection

Parameters:

id - the identifier of the -element to remove

getResources

public java.util.Vector<CPResource> getResources()

getResourceIterator

public java.util.Iterator<CPResource> getResourceIterator()

getResourceByID

public CPResource getResourceByID(java.lang.String identifier)

Returns the Resource with the specified identifier Returns null if Resource is not found

Parameters:

identifier -

Returns:

getElementByIdentifier

public org.dom4j.tree.DefaultElement getElementByIdentifier(java.lang.String id)

Specified by:

getElementByIdentifier in interface CPNode

Returns:

See Also:

CPNode.getElementByIdentifier(java.lang.String)

getPosition

public int getPosition()

Specified by:

getPosition in interface CPNode

Returns:

Returns the position of this Element

getParentElement

public CPManifest getParentElement()

getRootDir

public VFSContainer getRootDir()

getAllDependencies

public java.util.Vector<CPDependency> getAllDependencies()

returns all dependencies (CPDependency) in a vector

Returns:

getAllFiles

public java.util.Vector<CPFile> getAllFiles()

returns all files (CPFile) in a vector

Returns:

setPosition

public void setPosition(int pos)

Specified by:

setPosition in interface CPNode

setParentElement

public void setParentElement(CPManifest parent)