Class XMPSchemaMediaManagement

java.lang.Object
org.apache.jempbox.xmp.XMPSchema
org.apache.jempbox.xmp.XMPSchemaMediaManagement

public class XMPSchemaMediaManagement extends XMPSchema
Define XMP properties that are related to digital asset management.
Version:
$Revision: 1.2 $
Author:
Ben Litchfield
  • Field Details

  • Constructor Details

    • 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 Details

    • 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.
    • 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.
    • setDerivedFrom

      public void setDerivedFrom(ResourceRef resource)
      Set or clear the derived from value.
      Parameters:
      resource - The resource reference to set.
      See Also:
    • 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.
    • getDocumentID

      public String getDocumentID()
      Get id that identifies all versions of this document.
      Returns:
      The document id.
    • setVersionID

      public void setVersionID(String id)
      Parameters:
      id - An identifier for the current version.
    • getVersionID

      public String getVersionID()
      Returns:
      The current version 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.
    • removeHistory

      public void removeHistory(ResourceEvent event)
      Remove an event from the list of events.
      Parameters:
      event - The event to remove.
    • addHistory

      public void addHistory(ResourceEvent event)
      Add a new historical event.
      Parameters:
      event - The event to add to the list of history.
    • getManagedFrom

      public ResourceRef getManagedFrom()
      Get a reference to the document prior to it being managed.
      Returns:
      A reference to the managed document.
    • 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.
    • setManagedFrom

      public void setManagedFrom(ResourceRef resource)
      Set or clear the managed from value.
      Parameters:
      resource - The resource reference to set.
      See Also:
    • setManager

      public void setManager(String manager)
      Set the asset management system that manages this resource.
      Parameters:
      manager - The name of the asset management system.
    • getManager

      public String getManager()
      Get the name of the asset management system that manages this resource.
      Returns:
      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.
    • getManageTo

      public String getManageTo()
      Get the URI to the managed resource.
      Returns:
      The managed resource URI.
    • setManageUI

      public void setManageUI(String uri)
      Set the URI identifying information about the managed resource.
      Parameters:
      uri - URI to the managed resource info.
    • getManageUI

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