VdexReload 1.1.3 API

uk.ac.reload.moonunit
Class IMSDocumentHandler

java.lang.Object
  extended byuk.ac.reload.moonunit.IMSDocumentHandler
All Implemented Interfaces:
MoonUnitConstants
Direct Known Subclasses:
LDEditorDocumentHandler, ReloadEditorDocumentHandler

public class IMSDocumentHandler
extends java.lang.Object
implements MoonUnitConstants

Static fields for Namespaces, IMS versions and routines for handling these


Field Summary
static java.lang.String ADLCP_120_112
           
static java.lang.String ADLCP_120_113
           
static java.lang.String ADLCP_130
           
static org.jdom.Namespace ADLCP_NAMESPACE_12
           
static org.jdom.Namespace ADLCP_NAMESPACE_13
           
static java.lang.String ADLCP_NAMESPACE_PREFIX
           
static java.lang.String ADLCP_NAMESPACE_URI_12
           
static java.lang.String ADLCP_NAMESPACE_URI_13
           
static java.lang.String[] ADLCP_NAMESPACE_URIS
           
static java.lang.String[] BOGUS_NAMESPACE_MAPPING
           
static java.lang.String IMSCP_111
           
static java.lang.String IMSCP_112
           
static java.lang.String IMSCP_113
           
static java.lang.String IMSCP_NAMESPACE_PREFIX
           
static java.lang.String IMSCP_NAMESPACE_URI_111A
           
static java.lang.String IMSCP_NAMESPACE_URI_111B
           
static java.lang.String IMSCP_NAMESPACE_URI_111C
           
static java.lang.String IMSCP_NAMESPACE_URI_112
           
static java.lang.String IMSCP_NAMESPACE_URI_112A
           
static java.lang.String IMSCP_NAMESPACE_URI_113
           
static java.lang.String IMSCP_NAMESPACE_URI_113A
           
static java.lang.String[] IMSCP_NAMESPACE_URIS
           
static java.lang.String IMSLD_100
           
static java.lang.String IMSLD_100A
           
static java.lang.String IMSLD_100B
           
static java.lang.String IMSLD_100C
           
static java.lang.String IMSLD_NAMESPACE_PREFIX
           
static java.lang.String IMSLD_NAMESPACE_URI_10
           
static java.lang.String[] IMSLD_NAMESPACE_URIS
           
static java.lang.String IMSMD_110
           
static java.lang.String IMSMD_120
           
static java.lang.String IMSMD_121
           
static java.lang.String IMSMD_122
           
static java.lang.String IMSMD_NAMESPACE_PREFIX
           
static java.lang.String IMSMD_NAMESPACE_URI_11
           
static java.lang.String IMSMD_NAMESPACE_URI_112
           
static java.lang.String IMSMD_NAMESPACE_URI_121
           
static java.lang.String IMSMD_NAMESPACE_URI_121A
           
static java.lang.String IMSMD_NAMESPACE_URI_122
           
static java.lang.String IMSMD_NAMESPACE_URI_12A
           
static java.lang.String IMSMD_NAMESPACE_URI_12B
           
static java.lang.String IMSMD_NAMESPACE_URI_12C
           
static java.lang.String[] IMSMD_NAMESPACE_URIS
           
static java.lang.String IMSSS_100
           
static java.lang.String IMSSS_NAMESPACE_PREFIX
           
static java.lang.String IMSSS_NAMESPACE_URI_10
           
static java.lang.String[] IMSSS_NAMESPACE_URIS
           
static java.lang.String IMSVX_000
           
static java.lang.String IMSVX_100
           
static java.lang.String IMSVX_FLAT_000
           
static java.lang.String IMSVX_FLAT_100
           
static java.lang.String IMSVX_GLOSSARY_000
           
static java.lang.String IMSVX_GLOSSARY_100
           
static java.lang.String IMSVX_HIERARCHICAL_000
           
static java.lang.String IMSVX_HIERARCHICAL_100
           
static java.lang.String IMSVX_LAX_000
           
static java.lang.String IMSVX_LAX_100
           
static java.lang.String IMSVX_NAMESPACE_PREFIX
           
static java.lang.String IMSVX_NAMESPACE_URI_000
           
static java.lang.String IMSVX_NAMESPACE_URI_100
           
static java.lang.String[] IMSVX_NAMESPACE_URIS
           
static java.lang.String IMSVX_THESAURUS_000
           
static java.lang.String IMSVX_THESAURUS_100
           
static java.lang.String MANIFEST_NAME
          The Manifest name
static org.jdom.Namespace XSI_Namespace
          The XSI Namespace
static org.jdom.Namespace XSI_NamespaceOLD
          The Old XSI Namespace
static java.lang.String XSI_SchemaLocation
          The schemaLocation String
 
Fields inherited from interface uk.ac.reload.moonunit.MoonUnitConstants
DEBUG
 
Constructor Summary
IMSDocumentHandler()
           
 
Method Summary
static boolean containsManifest(java.io.File zipFile)
          Looks for imsmanifest.xml in a zip archive
static org.jdom.Namespace correctAdditionalNamespace(org.jdom.Document doc, org.jdom.Namespace ns)
          Check for bogus additional Namespace and correct it
static void correctAdditionalNamespaces(org.jdom.Document doc)
          Check for bogus additional Namespaces and correct them
static void correctLomElement(org.jdom.Element element)
          Replace the old "record" element with "lom" on MD
static org.jdom.Namespace getCorrectRootNamespace(org.jdom.Document doc)
          Check for bogus root Namespace and correct it
static org.jdom.Namespace getDocumentNamespace(org.jdom.Document doc)
          Get the root Namespace of the Document or null if not found
static org.jdom.Namespace getDocumentNamespace(org.jdom.Document doc, java.lang.String prefix)
          Get a given Namespace of the Document given its prefix or null if not found
static java.lang.String getSchemaLocation(org.jdom.Document doc, org.jdom.Namespace ns)
          Get the schema location for a given Namespace in a JDOM Document or null if not found
static java.lang.String getSchemaProfileVersion(org.jdom.Document doc)
          Get a (root) Schema Profile Version
static java.lang.String getSchemaVersion(org.jdom.Document doc)
          Get a (root) Schema version depending on an Instance ReloadDocument
static java.lang.String getSchemaVersionFromNamespace(org.jdom.Namespace ns)
          Get a version of the Schema depending on Namespace URI
static boolean isAcceptedMetadataNamespaceURI(java.lang.String nameSpaceURI)
           
static void replaceNamespaces(org.jdom.Element element, org.jdom.Namespace oldNamespace, org.jdom.Namespace newNamespace)
          Set child namespaces to MD Namespace.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

IMSMD_110

public static java.lang.String IMSMD_110

IMSMD_120

public static java.lang.String IMSMD_120

IMSMD_121

public static java.lang.String IMSMD_121

IMSMD_122

public static java.lang.String IMSMD_122

IMSVX_000

public static java.lang.String IMSVX_000

IMSVX_LAX_000

public static java.lang.String IMSVX_LAX_000

IMSVX_FLAT_000

public static java.lang.String IMSVX_FLAT_000

IMSVX_HIERARCHICAL_000

public static java.lang.String IMSVX_HIERARCHICAL_000

IMSVX_GLOSSARY_000

public static java.lang.String IMSVX_GLOSSARY_000

IMSVX_THESAURUS_000

public static java.lang.String IMSVX_THESAURUS_000

IMSVX_100

public static java.lang.String IMSVX_100

IMSVX_LAX_100

public static java.lang.String IMSVX_LAX_100

IMSVX_FLAT_100

public static java.lang.String IMSVX_FLAT_100

IMSVX_HIERARCHICAL_100

public static java.lang.String IMSVX_HIERARCHICAL_100

IMSVX_GLOSSARY_100

public static java.lang.String IMSVX_GLOSSARY_100

IMSVX_THESAURUS_100

public static java.lang.String IMSVX_THESAURUS_100

IMSCP_111

public static java.lang.String IMSCP_111

IMSCP_112

public static java.lang.String IMSCP_112

IMSCP_113

public static java.lang.String IMSCP_113

ADLCP_120_112

public static java.lang.String ADLCP_120_112

ADLCP_120_113

public static java.lang.String ADLCP_120_113

ADLCP_130

public static java.lang.String ADLCP_130

IMSSS_100

public static java.lang.String IMSSS_100

IMSLD_100

public static java.lang.String IMSLD_100

IMSLD_100A

public static java.lang.String IMSLD_100A

IMSLD_100B

public static java.lang.String IMSLD_100B

IMSLD_100C

public static java.lang.String IMSLD_100C

IMSMD_NAMESPACE_PREFIX

public static java.lang.String IMSMD_NAMESPACE_PREFIX

IMSMD_NAMESPACE_URI_122

public static java.lang.String IMSMD_NAMESPACE_URI_122

IMSMD_NAMESPACE_URI_121

public static java.lang.String IMSMD_NAMESPACE_URI_121

IMSMD_NAMESPACE_URI_121A

public static java.lang.String IMSMD_NAMESPACE_URI_121A

IMSMD_NAMESPACE_URI_12A

public static java.lang.String IMSMD_NAMESPACE_URI_12A

IMSMD_NAMESPACE_URI_12B

public static java.lang.String IMSMD_NAMESPACE_URI_12B

IMSMD_NAMESPACE_URI_12C

public static java.lang.String IMSMD_NAMESPACE_URI_12C

IMSMD_NAMESPACE_URI_11

public static java.lang.String IMSMD_NAMESPACE_URI_11

IMSMD_NAMESPACE_URI_112

public static java.lang.String IMSMD_NAMESPACE_URI_112

IMSMD_NAMESPACE_URIS

public static java.lang.String[] IMSMD_NAMESPACE_URIS

IMSVX_NAMESPACE_PREFIX

public static java.lang.String IMSVX_NAMESPACE_PREFIX

IMSVX_NAMESPACE_URI_000

public static java.lang.String IMSVX_NAMESPACE_URI_000

IMSVX_NAMESPACE_URI_100

public static java.lang.String IMSVX_NAMESPACE_URI_100

IMSVX_NAMESPACE_URIS

public static java.lang.String[] IMSVX_NAMESPACE_URIS

IMSCP_NAMESPACE_PREFIX

public static java.lang.String IMSCP_NAMESPACE_PREFIX

IMSCP_NAMESPACE_URI_113

public static java.lang.String IMSCP_NAMESPACE_URI_113

IMSCP_NAMESPACE_URI_113A

public static java.lang.String IMSCP_NAMESPACE_URI_113A

IMSCP_NAMESPACE_URI_112

public static java.lang.String IMSCP_NAMESPACE_URI_112

IMSCP_NAMESPACE_URI_112A

public static java.lang.String IMSCP_NAMESPACE_URI_112A

IMSCP_NAMESPACE_URI_111A

public static java.lang.String IMSCP_NAMESPACE_URI_111A

IMSCP_NAMESPACE_URI_111B

public static java.lang.String IMSCP_NAMESPACE_URI_111B

IMSCP_NAMESPACE_URI_111C

public static java.lang.String IMSCP_NAMESPACE_URI_111C

IMSCP_NAMESPACE_URIS

public static java.lang.String[] IMSCP_NAMESPACE_URIS

MANIFEST_NAME

public static final java.lang.String MANIFEST_NAME
The Manifest name

See Also:
Constant Field Values

ADLCP_NAMESPACE_PREFIX

public static java.lang.String ADLCP_NAMESPACE_PREFIX

ADLCP_NAMESPACE_URI_12

public static java.lang.String ADLCP_NAMESPACE_URI_12

ADLCP_NAMESPACE_12

public static org.jdom.Namespace ADLCP_NAMESPACE_12

ADLCP_NAMESPACE_URI_13

public static java.lang.String ADLCP_NAMESPACE_URI_13

ADLCP_NAMESPACE_13

public static org.jdom.Namespace ADLCP_NAMESPACE_13

ADLCP_NAMESPACE_URIS

public static java.lang.String[] ADLCP_NAMESPACE_URIS

IMSSS_NAMESPACE_PREFIX

public static java.lang.String IMSSS_NAMESPACE_PREFIX

IMSSS_NAMESPACE_URI_10

public static java.lang.String IMSSS_NAMESPACE_URI_10

IMSSS_NAMESPACE_URIS

public static java.lang.String[] IMSSS_NAMESPACE_URIS

IMSLD_NAMESPACE_PREFIX

public static java.lang.String IMSLD_NAMESPACE_PREFIX

IMSLD_NAMESPACE_URI_10

public static java.lang.String IMSLD_NAMESPACE_URI_10

IMSLD_NAMESPACE_URIS

public static java.lang.String[] IMSLD_NAMESPACE_URIS

XSI_Namespace

public static org.jdom.Namespace XSI_Namespace
The XSI Namespace


XSI_NamespaceOLD

public static org.jdom.Namespace XSI_NamespaceOLD
The Old XSI Namespace


XSI_SchemaLocation

public static java.lang.String XSI_SchemaLocation
The schemaLocation String


BOGUS_NAMESPACE_MAPPING

public static java.lang.String[] BOGUS_NAMESPACE_MAPPING
Constructor Detail

IMSDocumentHandler

public IMSDocumentHandler()
Method Detail

getSchemaVersion

public static java.lang.String getSchemaVersion(org.jdom.Document doc)
Get a (root) Schema version depending on an Instance ReloadDocument

Parameters:
doc - the ReloadDocument instance
Returns:
a (root) Schema version depending on an Instance ReloadDocument

getSchemaVersionFromNamespace

public static java.lang.String getSchemaVersionFromNamespace(org.jdom.Namespace ns)
Get a version of the Schema depending on Namespace URI

Parameters:
ns - the Namespace URI
Returns:
a version of the Schema depending on Namespace URI

getSchemaProfileVersion

public static java.lang.String getSchemaProfileVersion(org.jdom.Document doc)
Get a (root) Schema Profile Version

Parameters:
doc - the ReloadDocument instance
Returns:
a (root) Schema Profile Version

getCorrectRootNamespace

public static org.jdom.Namespace getCorrectRootNamespace(org.jdom.Document doc)
Check for bogus root Namespace and correct it

Parameters:
doc - the ReloadDocument instance
Returns:
the correct Namespace

correctAdditionalNamespaces

public static void correctAdditionalNamespaces(org.jdom.Document doc)
Check for bogus additional Namespaces and correct them

Parameters:
doc - the ReloadDocument instance

correctAdditionalNamespace

public static org.jdom.Namespace correctAdditionalNamespace(org.jdom.Document doc,
                                                            org.jdom.Namespace ns)
Check for bogus additional Namespace and correct it

Parameters:
doc - the ReloadDocument instance ns the document Namespace
Returns:
the correct Namespace

replaceNamespaces

public static void replaceNamespaces(org.jdom.Element element,
                                     org.jdom.Namespace oldNamespace,
                                     org.jdom.Namespace newNamespace)
Set child namespaces to MD Namespace. Will not affect other Namespaces

Parameters:
element - the element whose Namespace has to be changed oldNamespace the old Namespace of the element newNamespace the new Namespace of the element

correctLomElement

public static void correctLomElement(org.jdom.Element element)
Replace the old "record" element with "lom" on MD

Parameters:
element - the concerned element

getSchemaLocation

public static java.lang.String getSchemaLocation(org.jdom.Document doc,
                                                 org.jdom.Namespace ns)
Get the schema location for a given Namespace in a JDOM Document or null if not found

Parameters:
doc - the JDOM document ns the Namespace in the document
Returns:
the schema location for a given Namespace in a JDOM Document or null if not found

getDocumentNamespace

public static org.jdom.Namespace getDocumentNamespace(org.jdom.Document doc)
Get the root Namespace of the Document or null if not found

Parameters:
doc - the JDOM document
Returns:
the root Namespace of the Document or null if not found

getDocumentNamespace

public static org.jdom.Namespace getDocumentNamespace(org.jdom.Document doc,
                                                      java.lang.String prefix)
Get a given Namespace of the Document given its prefix or null if not found

Parameters:
doc - the JDOM document prefix the Namespace prefix
Returns:
a given Namespace of the Document given its prefix or null if not found

isAcceptedMetadataNamespaceURI

public static boolean isAcceptedMetadataNamespaceURI(java.lang.String nameSpaceURI)
Returns:
true if nameSpaceURI is in our list of accepted Metadata Namespace URIs

containsManifest

public static boolean containsManifest(java.io.File zipFile)
                                throws DweezilZipException
Looks for imsmanifest.xml in a zip archive

Parameters:
zipFile - the zip archive file
Returns:
either true or false
Throws:
DweezilZipException

VdexReload 1.1.3 API