org.olat.ims.cp.objects
Class CPResource

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

All Implemented Interfaces:

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

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

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

Initial Date: 26.06.2008

Author:

Sergio Trentini

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

CPResource()

CPResource(org.dom4j.tree.DefaultElement me)
this constructor is needed when building up the datamodel (parsing XML-manifest)

CPResource(java.lang.String identifier)
this constructor is used when creating a new resource (adding a new resource to the cp)

Method Summary

void	addDependency(CPDependency newDependency) adds a new CPDependency to the end of the dependencies vector
void	addFile(CPFile newFile) adds a new CPFile to the end of the files-vector (at the end)
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.lang.Object	clone()
java.util.Vector<CPDependency>	getDependencies()
java.util.Iterator<CPDependency>	getDependencyIterator()
org.dom4j.tree.DefaultElement	getElementByIdentifier(java.lang.String id)
java.util.Vector<CPFile>	getFiles()
java.lang.String	getFullHref()
java.lang.String	getHref()
java.lang.String	getIdentifier()
CPResources	getParentElement()
int	getPosition()
java.lang.String	getType()
java.lang.String	getXMLBase()
void	removeFromManifest() removes this object from the manifest.
void	removeLinkedFiles() Removes all linked files from the file-system
void	removeReferencedFile() Removes the single file that the resource references to.
void	setHref(java.lang.String href)
void	setIdentifier(java.lang.String identifier)
void	setMetadata(CPMetadata md)
void	setParentElement(CPResources parent)
void	setPosition(int pos)
void	setType(java.lang.String type)
void	setXMLBase(java.lang.String xmlBase)
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, 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

CPResource

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

this constructor is needed when building up the datamodel (parsing XML-manifest)

Parameters:

me -

CPResource

public CPResource(java.lang.String identifier)

this constructor is used when creating a new resource (adding a new resource to the cp)

CPResource

public CPResource()

Method Detail

clone

public java.lang.Object clone()

Specified by:

clone in interface org.dom4j.Node

Overrides:

clone in class org.dom4j.tree.DefaultElement

See Also:

DefaultElement.clone()

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

See Also:

org.olat.ims.cp.objects.CPNode#getXML(java.lang.StringBuilder)

addFile

public void addFile(CPFile newFile)

adds a new CPFile to the end of the files-vector (at the end)

addDependency

public void addDependency(CPDependency newDependency)

adds a new CPDependency to the end of the dependencies vector

Parameters:

newDependency -

removeFromManifest

public void removeFromManifest()

removes this object from the manifest. and deletes linked files from the FileSystem

removeLinkedFiles

public void removeLinkedFiles()

Removes all linked files from the file-system

removeReferencedFile

public void removeReferencedFile()

Removes the single file that the resource references to. All other files beloning to the resource remain untouched.

getHref

public java.lang.String getHref()

getFullHref

public java.lang.String getFullHref()

getType

public java.lang.String getType()

getIdentifier

public java.lang.String getIdentifier()

getXMLBase

public java.lang.String getXMLBase()

getFiles

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

getDependencies

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

getDependencyIterator

public java.util.Iterator<CPDependency> getDependencyIterator()

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 CPResources getParentElement()

setHref

public void setHref(java.lang.String href)

setIdentifier

public void setIdentifier(java.lang.String identifier)

setType

public void setType(java.lang.String type)

setXMLBase

public void setXMLBase(java.lang.String xmlBase)

setPosition

public void setPosition(int pos)

Specified by:

setPosition in interface CPNode

setParentElement

public void setParentElement(CPResources parent)

setMetadata

public void setMetadata(CPMetadata md)