Package org.apache.jempbox.xmp
Class XMPSchemaMediaManagement
java.lang.Object
org.apache.jempbox.xmp.XMPSchema
org.apache.jempbox.xmp.XMPSchemaMediaManagement
Define XMP properties that are related to digital asset management.
- Version:
- $Revision: 1.2 $
- Author:
- Ben Litchfield
-
Field Summary
FieldsFields inherited from class org.apache.jempbox.xmp.XMPSchema
NS_NAMESPACE, prefix, schema
-
Constructor Summary
ConstructorsConstructorDescriptionXMPSchemaMediaManagement
(XMPMetadata parent) Construct a new blank PDF schema.XMPSchemaMediaManagement
(Element element, String prefix) Constructor from existing XML element. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addHistory
(ResourceEvent event) Add a new historical event.Create a new Derived From resource ref that can be populated.Create a new Managed From resource ref that can be populated.Get a reference to the original document that this document is derived from.Get id that identifies all versions of this document.Get a list of all historical events that have occured for this resource.Get a reference to the document prior to it being managed.Get the name of the asset management system that manages this resource.Get the URI to the managed resource.Get the URI to the managed resource information.void
removeHistory
(ResourceEvent event) Remove an event from the list of events.void
setDerivedFrom
(ResourceRef resource) Set or clear the derived from value.void
setDocumentID
(String id) Set the common identifier to all versions of this document.void
setManagedFrom
(ResourceRef resource) Set or clear the managed from value.void
setManager
(String manager) Set the asset management system that manages this resource.void
setManageTo
(String uri) Set the URI identifying the managed resource.void
setManageUI
(String uri) Set the URI identifying information about the managed resource.void
setVersionID
(String id) Methods inherited from class org.apache.jempbox.xmp.XMPSchema
addBagValue, addSequenceDateValue, addSequenceValue, addSequenceValue, getAbout, getBagList, getBooleanProperty, getDateProperty, getElement, getEventSequenceList, getIntegerProperty, getLanguageProperty, getLanguagePropertyLanguages, getSequenceDateList, getSequenceList, getTextProperty, getThumbnailProperty, merge, removeBagValue, removeSequenceDateValue, removeSequenceValue, removeSequenceValue, setAbout, setBooleanProperty, setDateProperty, setIntegerProperty, setLanguageProperty, setTextProperty, setThumbnailProperty
-
Field Details
-
NAMESPACE
The namespace for this schema.- See Also:
-
-
Constructor Details
-
XMPSchemaMediaManagement
Construct a new blank PDF schema.- Parameters:
parent
- The parent metadata schema that this will be part of.
-
XMPSchemaMediaManagement
Constructor from existing XML element.- Parameters:
element
- The existing element.prefix
- The schema prefix.
-
-
Method Details
-
getDerivedFrom
Get a reference to the original document that this document is derived from.- Returns:
- A reference to the derived document, or null if one does not exist.
-
createDerivedFrom
Create a new Derived From resource ref that can be populated. You will still need to call setDerivedFrom after this is created.- Returns:
- A new blank derived from instance.
-
setDerivedFrom
Set or clear the derived from value.- Parameters:
resource
- The resource reference to set.- See Also:
-
setDocumentID
Set the common identifier to all versions of this document. It should be based on a UUID.- Parameters:
id
- An identifier for the document.
-
getDocumentID
Get id that identifies all versions of this document.- Returns:
- The document id.
-
setVersionID
- Parameters:
id
- An identifier for the current version.
-
getVersionID
- Returns:
- The current version id.
-
getHistory
Get a list of all historical events that have occured for this resource.- Returns:
- A list of ResourceEvent objects or null.
-
removeHistory
Remove an event from the list of events.- Parameters:
event
- The event to remove.
-
addHistory
Add a new historical event.- Parameters:
event
- The event to add to the list of history.
-
getManagedFrom
Get a reference to the document prior to it being managed.- Returns:
- A reference to the managed document.
-
createManagedFrom
Create a new Managed From resource ref that can be populated. You will still need to call setManagedFrom after this is created.- Returns:
- A new blank managed from instance.
-
setManagedFrom
Set or clear the managed from value.- Parameters:
resource
- The resource reference to set.- See Also:
-
setManager
Set the asset management system that manages this resource.- Parameters:
manager
- The name of the asset management system.
-
getManager
Get the name of the asset management system that manages this resource.- Returns:
- The name of the asset management system.
-
setManageTo
Set the URI identifying the managed resource.- Parameters:
uri
- URI to the managed resource.
-
getManageTo
Get the URI to the managed resource.- Returns:
- The managed resource URI.
-
setManageUI
Set the URI identifying information about the managed resource.- Parameters:
uri
- URI to the managed resource info.
-
getManageUI
Get the URI to the managed resource information.- Returns:
- The managed resource information URI.
-