org.olat.ims.cp.objects
Class CPOrganizations

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

All Implemented Interfaces:

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

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

Description:
This class represents a organizations-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

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

CPOrganizations(org.dom4j.tree.DefaultElement me)
this constructor is used when building up the CP (parsing XML)

Method Summary

void	addOrganization(CPOrganization newOrganization) adds a new CPOrganization to the end of the orgas-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
org.dom4j.tree.DefaultElement	getElementByIdentifier(java.lang.String id)
CPOrganization	getOrganizationByID(java.lang.String id) Returns the Organization with identifier id Returns null if O.
java.util.Iterator<CPOrganization>	getOrganizationIterator()
java.util.Vector<CPOrganization>	getOrganizations()
CPManifest	getParentElement()
int	getPosition()
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

CPOrganizations

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

this constructor is used when building up the CP (parsing XML)

Parameters:

me -

CPOrganizations

public CPOrganizations()

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

See Also:

org.olat.ims.cp.objects.CPNode#buildDocument(org.dom4j.tree.DefaultDocument)

addOrganization

public void addOrganization(CPOrganization newOrganization)

adds a new CPOrganization to the end of the orgas-vector

getOrganizations

public java.util.Vector<CPOrganization> getOrganizations()

Returns:

getOrganizationIterator

public java.util.Iterator<CPOrganization> getOrganizationIterator()

getPosition

public int getPosition()

Specified by:

getPosition in interface CPNode

Returns:

Returns the position of this Element

See Also:

CPNode.getPosition()

getOrganizationByID

public CPOrganization getOrganizationByID(java.lang.String id)

Returns the Organization with identifier id Returns null if O. is not found

Parameters:

id -

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)

getParentElement

public CPManifest getParentElement()

setPosition

public void setPosition(int pos)

Specified by:

setPosition in interface CPNode

See Also:

CPNode.setPosition(int)

setParentElement

public void setParentElement(CPManifest parent)