org.apache.jempbox.xmp

Class XMPSchemaMediaManagement

public class XMPSchemaMediaManagement extends XMPSchema

Define XMP properties that are related to digital asset management.

Version: $Revision: 1.2 $

Author: Ben Litchfield

Field Summary
static StringNAMESPACE
The namespace for this schema.
Constructor Summary
XMPSchemaMediaManagement(XMPMetadata parent)
Construct a new blank PDF schema.
XMPSchemaMediaManagement(Element element, String prefix)
Constructor from existing XML element.
Method Summary
voidaddHistory(ResourceEvent event)
Add a new historical event.
ResourceRefcreateDerivedFrom()
Create a new Derived From resource ref that can be populated.
ResourceRefcreateManagedFrom()
Create a new Managed From resource ref that can be populated.
ResourceRefgetDerivedFrom()
Get a reference to the original document that this document is derived from.
StringgetDocumentID()
Get id that identifies all versions of this document.
List<ResourceEvent>getHistory()
Get a list of all historical events that have occured for this resource.
ResourceRefgetManagedFrom()
Get a reference to the document prior to it being managed.
StringgetManager()
Get the name of the asset management system that manages this resource.
StringgetManageTo()
Get the URI to the managed resource.
StringgetManageUI()
Get the URI to the managed resource information.
StringgetVersionID()
voidremoveHistory(ResourceEvent event)
Remove an event from the list of events.
voidsetDerivedFrom(ResourceRef resource)
Set or clear the derived from value.
voidsetDocumentID(String id)
Set the common identifier to all versions of this document.
voidsetManagedFrom(ResourceRef resource)
Set or clear the managed from value.
voidsetManager(String manager)
Set the asset management system that manages this resource.
voidsetManageTo(String uri)
Set the URI identifying the managed resource.
voidsetManageUI(String uri)
Set the URI identifying information about the managed resource.
voidsetVersionID(String id)

Field Detail

NAMESPACE

public static final String NAMESPACE
The namespace for this schema.

Constructor Detail

XMPSchemaMediaManagement

public XMPSchemaMediaManagement(XMPMetadata parent)
Construct a new blank PDF schema.

Parameters: parent The parent metadata schema that this will be part of.

XMPSchemaMediaManagement

public XMPSchemaMediaManagement(Element element, String prefix)
Constructor from existing XML element.

Parameters: element The existing element. prefix The schema prefix.

Method Detail

addHistory

public void addHistory(ResourceEvent event)
Add a new historical event.

Parameters: event The event to add to the list of history.

createDerivedFrom

public ResourceRef 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.

createManagedFrom

public ResourceRef 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.

getDerivedFrom

public ResourceRef 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.

getDocumentID

public String getDocumentID()
Get id that identifies all versions of this document.

Returns: The document id.

getHistory

public List<ResourceEvent> getHistory()
Get a list of all historical events that have occured for this resource.

Returns: A list of ResourceEvent objects or null.

getManagedFrom

public ResourceRef getManagedFrom()
Get a reference to the document prior to it being managed.

Returns: A reference to the managed document.

getManager

public String getManager()
Get the name of the asset management system that manages this resource.

Returns: The name of the asset management system.

getManageTo

public String getManageTo()
Get the URI to the managed resource.

Returns: The managed resource URI.

getManageUI

public String getManageUI()
Get the URI to the managed resource information.

Returns: The managed resource information URI.

getVersionID

public String getVersionID()

Returns: The current version id.

removeHistory

public void removeHistory(ResourceEvent event)
Remove an event from the list of events.

Parameters: event The event to remove.

setDerivedFrom

public void setDerivedFrom(ResourceRef resource)
Set or clear the derived from value.

Parameters: resource The resource reference to set.

See Also: createDerivedFrom

setDocumentID

public void setDocumentID(String id)
Set the common identifier to all versions of this document. It should be based on a UUID.

Parameters: id An identifier for the document.

setManagedFrom

public void setManagedFrom(ResourceRef resource)
Set or clear the managed from value.

Parameters: resource The resource reference to set.

See Also: createManagedFrom

setManager

public void setManager(String manager)
Set the asset management system that manages this resource.

Parameters: manager The name of the asset management system.

setManageTo

public void setManageTo(String uri)
Set the URI identifying the managed resource.

Parameters: uri URI to the managed resource.

setManageUI

public void setManageUI(String uri)
Set the URI identifying information about the managed resource.

Parameters: uri URI to the managed resource info.

setVersionID

public void setVersionID(String id)

Parameters: id An identifier for the current version.

Copyright © 2008-2011 Apache Software Foundation. All Rights Reserved.