|
VdexReload 1.1.3 API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.reload.moonunit.dom.ReloadDocument
uk.ac.reload.moonunit.dom.ReloadSchemaDocument
uk.ac.reload.editor.contentpackaging.ContentPackage
The Content Package Class
Nested Class Summary |
Nested classes inherited from class uk.ac.reload.moonunit.dom.ReloadSchemaDocument |
ReloadSchemaDocument.UndoableAddAction, ReloadSchemaDocument.UndoableCopyAction, ReloadSchemaDocument.UndoableCutAction, ReloadSchemaDocument.UndoableDeleteAction, ReloadSchemaDocument.UndoableMoveAction, ReloadSchemaDocument.UndoablePasteAction |
Field Summary | |
protected ContentPackageCore |
_cpCore
Delegate class for common CP functionality |
Fields inherited from class uk.ac.reload.moonunit.dom.ReloadSchemaDocument |
_controller, _undoHandler |
Fields inherited from class uk.ac.reload.moonunit.dom.ReloadDocument |
_dirty, _doc, _file |
Constructor Summary | |
ContentPackage()
Default Constructor |
|
ContentPackage(java.io.File file,
org.jdom.Document doc,
ContentPackageSchemaController schemaController)
Constructor |
Method Summary | |
boolean |
acceptElement(org.jdom.Element sourceElement,
org.jdom.Element targetElement,
int actionCopyMove)
|
boolean |
acceptsReloadResources(org.jdom.Element targetElement)
Return whether targetElement can accept ReloadResources |
org.jdom.Element |
addElementBySchema(java.lang.Object source,
org.jdom.Element parentElement,
ReloadSchemaElement newSchemaElement,
boolean doSelect)
Over-ride this so we can intercept it to do stuff |
protected org.jdom.Element |
addFileElement(java.io.File reloadResource,
org.jdom.Element resourceElement,
boolean doSelect)
Add a |
protected void |
addFileElements(ReloadResource reloadResource,
org.jdom.Element resourceElement,
boolean doSelect)
Add File dependencies for a ReloadResource. |
protected org.jdom.Element |
addItemManifest(org.jdom.Element manifestElement,
org.jdom.Element targetElement,
boolean doSelect)
Add an Item to Item or Organization parent - this references a sub-Manifest |
protected org.jdom.Element |
addItemResource(org.jdom.Element parentElement,
org.jdom.Element resourceElement,
boolean doSelect)
Add an Item to Item or Organization parent - this references a Resource If resourcesElement is not null set the Item's identifierref to it |
protected org.jdom.Element |
addItemTitle(org.jdom.Element itemElement,
org.jdom.Element resourceElement)
Add a Title to an Item based on the Resource it References. |
protected org.jdom.Element |
addOrganization(org.jdom.Element parentElement,
boolean doSelect)
Add an Organization |
org.jdom.Element |
addReloadResource(ReloadResource reloadResource,
org.jdom.Element parentElement)
Add a ReloadResource to the Manifest |
protected org.jdom.Element |
addReloadResource(ReloadResource reloadResource,
org.jdom.Element parentElement,
boolean doSelect)
Add a ReloadResource to a given Element |
org.jdom.Element |
addReloadResources(ReloadResource[] reloadResources,
org.jdom.Element parentElement)
Add a bunch of ReloadResources to the Manifest |
protected org.jdom.Element |
addReloadResourceToResourcesElement(ReloadResource reloadResource,
org.jdom.Element resourcesElement,
boolean doSelect)
Add a Resource to the "resources" element |
protected org.jdom.Element |
addTitle(org.jdom.Element parentElement,
java.lang.String text)
Add a Title element (only one allowed). |
boolean |
canCopyElement(org.jdom.Element element)
Decides whether an element can be copied or not - will need to override this |
boolean |
canCutElement(org.jdom.Element element,
ReloadSchemaElement schemaElement)
Decides whether we can cut an element - will need to override this |
boolean |
canDragElement(org.jdom.Element element,
int action)
|
boolean |
canPasteFromClipboard(org.jdom.Element element)
Decides whether we can paste an element - will need to override this |
protected void |
checkIDRefs(org.jdom.Element element)
If we move or copy an Element that contains an IDENTIFIERREF to another Element we check that the Element referenced is still below us. |
protected boolean |
containsFile(java.lang.String href,
org.jdom.Element resourceElement)
Return whether a Resource Element contains a File Element by HREF |
protected boolean |
containsReloadResource(ReloadResource reloadResource,
org.jdom.Element resourcesElement)
|
boolean |
containsResource(org.jdom.Element sourceElement,
org.jdom.Element resourcesElement)
Return whether resourcesElement already contains sourceElement as a Resource This searches by the HREF attribute |
protected boolean |
containsResource(java.lang.String href,
org.jdom.Element resourcesElement)
Return whether a Resources Element contains a Resource by HREF |
org.jdom.Element |
copyElementUndoable(java.lang.Object source,
org.jdom.Element element,
org.jdom.Element newParent,
boolean doSelect)
Over-ride this so we can intercept it to do stuff |
protected void |
copypasteElement(org.jdom.Element newElement)
When an Element is copied over or pasted we need to do a bunch of stuff |
protected void |
createNewIDRefs(org.jdom.Element element,
java.util.Hashtable id_map)
Create new IDENTIFIERREFs and DEFAULT attributes |
protected java.util.Hashtable |
createNewIDs(org.jdom.Element element)
Create a new ID for an Element that has an IDENTIFIER attribute and also for its children Only works if the Element already has an IDENTIFIER attribute |
protected void |
createNewIDs(org.jdom.Element element,
java.util.Hashtable idmap)
|
protected void |
createNewPrerequisiteRefs(org.jdom.Element element,
java.util.Hashtable id_map)
Create new SCORM Prerequisite Refs Really this method should be in the SCORM1_2Package class |
boolean |
exportManifest(org.jdom.Element manifestElement,
java.io.File targetFolder)
Export (disagggregate) manifestElement to new Content Package |
protected java.lang.String |
generateUniqueID(org.jdom.Element element)
Generate a Unique Identifier for an Element |
java.lang.String[] |
getComments()
Get the comments to add to the XML document |
org.jdom.Element |
getDefaultOrganization(org.jdom.Element orgsElement)
|
java.lang.String |
getElementBase(org.jdom.Element element)
|
org.jdom.Element |
getElementByIdentifier(org.jdom.Element parent,
java.lang.String identifier)
|
java.lang.String |
getElementDisplayName(org.jdom.Element element)
|
java.lang.String |
getElementHREF(org.jdom.Element element)
|
org.jdom.Element[] |
getElementsInManifest(org.jdom.Element manifestElement,
java.lang.String elementName,
org.jdom.Namespace ns)
|
org.jdom.Element |
getFile(java.lang.String href,
org.jdom.Element resourceElement)
Return a File Element given its HREF |
protected org.jdom.Element |
getFileByReloadResouce(ReloadResource reloadResource,
org.jdom.Element resourceElement)
|
org.jdom.Namespace |
getMetadataNamespace()
|
org.jdom.Element[] |
getOrganizations(org.jdom.Element orgsElement)
|
org.jdom.Element[] |
getOrganizationsAllowed(org.jdom.Element orgsElement)
|
java.lang.String |
getParameters(org.jdom.Element element)
|
org.jdom.Element |
getParentManifestElement(org.jdom.Element element)
Find the local parent "manifest" Element for a given Element If element is the manifest, will return that |
java.io.File |
getProjectFolder()
|
java.lang.String |
getProjectName()
|
org.jdom.Element |
getReferencedElement(org.jdom.Element sourceElement)
|
org.jdom.Element[] |
getReferencedElementsAllowed(org.jdom.Element element)
|
java.lang.String[] |
getReferencedIdentifersAllowed(org.jdom.Element element)
|
org.jdom.Element |
getResource(java.lang.String href,
org.jdom.Element resourcesElement)
Return a Resource Element given its HREF |
protected org.jdom.Element |
getResourceByReloadResouce(ReloadResource reloadResource,
org.jdom.Element resourcesElement)
|
java.io.File |
getResourceFile(org.jdom.Element element)
|
java.io.File[] |
getResourceFiles(org.jdom.Element manifestElement)
|
org.jdom.Element |
getResourcesElement(org.jdom.Element element)
Find the local "resources" Element for a given Element position. |
java.lang.String |
getTargetRootElementName()
Get the Target Root element name |
java.lang.String |
getURL(org.jdom.Element element)
|
org.jdom.Element |
importManifest(java.io.File manifestFile,
org.jdom.Element manifestElement,
java.lang.String base)
Import (aggregate) another Package into this Content Package at manifestElement |
boolean |
isMetadataElement(java.lang.String name)
Return whether we have the "metadata" element |
boolean |
isMetadataRoot(java.lang.String name)
Return whether we have the MD root name of any embedded Metadata "lom" |
boolean |
isReferencingElement(org.jdom.Element element)
|
void |
newContentPackage(java.io.File projectFolder,
ContentPackageSchemaController cpController,
MetadataSchemaController mdController)
Set up New CP with new project folder, imsmanifest.xml amd Schema files |
protected void |
newDocument(java.io.File projectFolder,
ContentPackageSchemaController cpController,
MetadataSchemaController mdController)
Setup the JDOM Document with Namespaces set and root element set and some default attributes. |
org.jdom.Element |
pasteElementUndoable(java.lang.Object source,
org.jdom.Element element,
org.jdom.Element newParent,
boolean doSelect)
Over-ride this so we can intercept it to do stuff |
protected void |
setDefaultOrganization(org.jdom.Element organization)
When an Organization element is added/copied to an Organizations Element and it is the only one, set the Organizations "default" attribute to it |
org.jdom.Element |
shiftElement(org.jdom.Element sourceElement,
org.jdom.Element targetElement,
int action)
Copy/Move sourceElement to targetElement action is either ACTION_COPY or ACTION MOVE |
protected org.jdom.Element |
shiftElement(org.jdom.Element sourceElement,
org.jdom.Element targetElement,
int action,
boolean doSelect)
|
Methods inherited from class uk.ac.reload.moonunit.dom.ReloadDocument |
getDocument, getFile, getRootElement, isDirty, isDocumentNamespace, isMemberOfSameDocument, loadDocument, saveAsDocument, setDirty |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected ContentPackageCore _cpCore
Constructor Detail |
public ContentPackage()
public ContentPackage(java.io.File file, org.jdom.Document doc, ContentPackageSchemaController schemaController)
Method Detail |
public void newContentPackage(java.io.File projectFolder, ContentPackageSchemaController cpController, MetadataSchemaController mdController) throws ReloadEditorException
ReloadEditorException
protected void newDocument(java.io.File projectFolder, ContentPackageSchemaController cpController, MetadataSchemaController mdController) throws ReloadEditorException
ReloadEditorException
public java.lang.String[] getComments()
ReloadSchemaDocument
getComments
in class ReloadSchemaDocument
public org.jdom.Element importManifest(java.io.File manifestFile, org.jdom.Element manifestElement, java.lang.String base) throws ReloadEditorException
ReloadEditorException
public boolean exportManifest(org.jdom.Element manifestElement, java.io.File targetFolder) throws ReloadEditorException
ReloadEditorException
public java.lang.String getTargetRootElementName()
ReloadSchemaDocument
getTargetRootElementName
in class ReloadSchemaDocument
public java.lang.String getProjectName()
public java.io.File getProjectFolder()
public boolean canCopyElement(org.jdom.Element element)
ReloadSchemaDocument
canCopyElement
in class ReloadSchemaDocument
element
- the element which we are testing
public boolean canCutElement(org.jdom.Element element, ReloadSchemaElement schemaElement)
ReloadSchemaDocument
canCutElement
in class ReloadSchemaDocument
element
- the element which we are testing
schemaElement the schemaElement against which we are testing
public boolean canPasteFromClipboard(org.jdom.Element element)
ReloadSchemaDocument
canPasteFromClipboard
in class ReloadSchemaDocument
element
- the element which we are testing
public boolean canDragElement(org.jdom.Element element, int action)
public boolean acceptElement(org.jdom.Element sourceElement, org.jdom.Element targetElement, int actionCopyMove)
public org.jdom.Element shiftElement(org.jdom.Element sourceElement, org.jdom.Element targetElement, int action)
protected org.jdom.Element shiftElement(org.jdom.Element sourceElement, org.jdom.Element targetElement, int action, boolean doSelect)
public org.jdom.Element addElementBySchema(java.lang.Object source, org.jdom.Element parentElement, ReloadSchemaElement newSchemaElement, boolean doSelect)
addElementBySchema
in class ReloadSchemaDocument
source
- who is telling us thisparentElement
- the parent Element to add tonewSchemaElement
- the Type of Element we want to adddoSelect
- true or false depending on whether the new added element should be selected or not on the user interfacepublic org.jdom.Element copyElementUndoable(java.lang.Object source, org.jdom.Element element, org.jdom.Element newParent, boolean doSelect)
copyElementUndoable
in class ReloadSchemaDocument
source
- who is telling us this
element the element to be copied
newParent the new parent element
doSelect true or false depending on whether the new added element should be selected or not on the user interface
public org.jdom.Element pasteElementUndoable(java.lang.Object source, org.jdom.Element element, org.jdom.Element newParent, boolean doSelect)
pasteElementUndoable
in class ReloadSchemaDocument
source
- who is telling us this
element the element to be pasted
newParent the new parent element
doSelect true or false depending on whether the new added element should be selected or not on the user interface
protected void copypasteElement(org.jdom.Element newElement)
protected org.jdom.Element addItemManifest(org.jdom.Element manifestElement, org.jdom.Element targetElement, boolean doSelect)
protected org.jdom.Element addItemResource(org.jdom.Element parentElement, org.jdom.Element resourceElement, boolean doSelect)
protected org.jdom.Element addOrganization(org.jdom.Element parentElement, boolean doSelect)
protected org.jdom.Element addTitle(org.jdom.Element parentElement, java.lang.String text)
protected org.jdom.Element addItemTitle(org.jdom.Element itemElement, org.jdom.Element resourceElement)
public java.lang.String getElementDisplayName(org.jdom.Element element)
public org.jdom.Element getReferencedElement(org.jdom.Element sourceElement)
public boolean isReferencingElement(org.jdom.Element element)
public java.lang.String[] getReferencedIdentifersAllowed(org.jdom.Element element)
public org.jdom.Element[] getReferencedElementsAllowed(org.jdom.Element element)
public org.jdom.Element[] getOrganizations(org.jdom.Element orgsElement)
public org.jdom.Element[] getOrganizationsAllowed(org.jdom.Element orgsElement)
public org.jdom.Element getDefaultOrganization(org.jdom.Element orgsElement)
public org.jdom.Element getParentManifestElement(org.jdom.Element element)
public org.jdom.Element[] getElementsInManifest(org.jdom.Element manifestElement, java.lang.String elementName, org.jdom.Namespace ns)
public org.jdom.Element getElementByIdentifier(org.jdom.Element parent, java.lang.String identifier)
public org.jdom.Namespace getMetadataNamespace()
getMetadataNamespace
in interface AbstractContentPackage
public boolean isMetadataRoot(java.lang.String name)
isMetadataRoot
in interface AbstractContentPackage
public boolean isMetadataElement(java.lang.String name)
isMetadataElement
in interface AbstractContentPackage
public java.lang.String getURL(org.jdom.Element element)
public java.lang.String getElementHREF(org.jdom.Element element)
public java.lang.String getElementBase(org.jdom.Element element)
public java.lang.String getParameters(org.jdom.Element element)
public java.io.File getResourceFile(org.jdom.Element element)
public java.io.File[] getResourceFiles(org.jdom.Element manifestElement)
public org.jdom.Element getResource(java.lang.String href, org.jdom.Element resourcesElement)
public org.jdom.Element getFile(java.lang.String href, org.jdom.Element resourceElement)
public org.jdom.Element getResourcesElement(org.jdom.Element element)
protected void createNewIDRefs(org.jdom.Element element, java.util.Hashtable id_map)
protected void createNewPrerequisiteRefs(org.jdom.Element element, java.util.Hashtable id_map)
protected java.util.Hashtable createNewIDs(org.jdom.Element element)
protected void createNewIDs(org.jdom.Element element, java.util.Hashtable idmap)
protected void checkIDRefs(org.jdom.Element element)
protected java.lang.String generateUniqueID(org.jdom.Element element)
protected void setDefaultOrganization(org.jdom.Element organization)
public org.jdom.Element addReloadResources(ReloadResource[] reloadResources, org.jdom.Element parentElement)
public org.jdom.Element addReloadResource(ReloadResource reloadResource, org.jdom.Element parentElement)
protected org.jdom.Element addReloadResource(ReloadResource reloadResource, org.jdom.Element parentElement, boolean doSelect)
protected org.jdom.Element addReloadResourceToResourcesElement(ReloadResource reloadResource, org.jdom.Element resourcesElement, boolean doSelect)
protected boolean containsReloadResource(ReloadResource reloadResource, org.jdom.Element resourcesElement)
protected org.jdom.Element getResourceByReloadResouce(ReloadResource reloadResource, org.jdom.Element resourcesElement)
protected org.jdom.Element getFileByReloadResouce(ReloadResource reloadResource, org.jdom.Element resourceElement)
public boolean containsResource(org.jdom.Element sourceElement, org.jdom.Element resourcesElement)
protected boolean containsResource(java.lang.String href, org.jdom.Element resourcesElement)
protected boolean containsFile(java.lang.String href, org.jdom.Element resourceElement)
public boolean acceptsReloadResources(org.jdom.Element targetElement)
protected void addFileElements(ReloadResource reloadResource, org.jdom.Element resourceElement, boolean doSelect)
protected org.jdom.Element addFileElement(java.io.File reloadResource, org.jdom.Element resourceElement, boolean doSelect)
|
VdexReload 1.1.3 API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |