org.jempbox.xmp
Class ResourceRef
java.lang.Object
org.jempbox.xmp.ResourceRef
- Elementable
public class ResourceRef
extends java.lang.Object
This class represents a multiple part reference to a resource.
- Ben Litchfield (ben@benlitchfield.com)
protected Element | parent - The DOM representation of this object.
|
ResourceRef(Element parentElement) - Create a resource reference based on a existing parent property set.
|
String | getDocumentID() - Get the referenced resource's document id.
|
Element | getElement() - Get the underlying XML element.
|
String | getInstanceID() - Get the referenced resource's id.
|
String | getManager() - Get name of the asset management system that manages this resource.
|
String | getManagerTo() - URI identifying the managed resource.
|
String | getManagerUI() - URI to info about the managed resource.
|
String | getManagerVariant() - Get name of the variant of asset management system that manages this resource.
|
String | getRenditionClass() - Get the rendition class.
|
String | getRenditionParams() - Get the extra rendition params.
|
String | getVersionID() - Get the referenced resource's document version id.
|
void | setDocumentID(String id) - Set the referenced resource's document id.
|
void | setInstanceID(String id) - Set the referenced resource's id.
|
void | setMangager(String manager) - Set the name of the system that manages this resource.
|
void | setMangagerTo(String managerTo) - Set the URI to the managed resource.
|
void | setMangagerUI(String managerUI) - Set the URI to the info about the managed resource.
|
void | setMangagerVariant(String managerVariant) - Set the name of the variant of the system that manages this resource.
|
void | setRenditionClass(String renditionClass) - Set the rendition class.
|
void | setRenditionParams(String params) - Set addition rendition params.
|
void | setVersionID(String id) - Set the referenced resource's version id.
|
parent
protected Element parent
The DOM representation of this object.
ResourceRef
public ResourceRef(Element parentElement)
Create a resource reference based on a existing parent property set.
parentElement
- The parent element that will store the resource properties.
getDocumentID
public String getDocumentID()
Get the referenced resource's document id.
- The id of the reference document.
getElement
public Element getElement()
Get the underlying XML element.
- getElement in interface Elementable
- The XML element that this object represents.
getInstanceID
public String getInstanceID()
Get the referenced resource's id.
getManager
public String getManager()
Get name of the asset management system that manages this resource.
- The name of a asset management system.
getManagerTo
public String getManagerTo()
URI identifying the managed resource.
getManagerUI
public String getManagerUI()
URI to info about the managed resource.
- The URI to the resource info.
getManagerVariant
public String getManagerVariant()
Get name of the variant of asset management system that manages this resource.
- The name of a asset management system.
getRenditionClass
public String getRenditionClass()
Get the rendition class.
- The value of the rendition class property.
getRenditionParams
public String getRenditionParams()
Get the extra rendition params.
- Additional rendition parameters.
getVersionID
public String getVersionID()
Get the referenced resource's document version id.
- The id of the reference document version.
setDocumentID
public void setDocumentID(String id)
Set the referenced resource's document id.
id
- The id of the reference document.
setInstanceID
public void setInstanceID(String id)
Set the referenced resource's id.
id
- The id of the reference.
setMangager
public void setMangager(String manager)
Set the name of the system that manages this resource.
manager
- The name of the management system.
setMangagerTo
public void setMangagerTo(String managerTo)
Set the URI to the managed resource.
managerTo
- The URI to the managed resource.
setMangagerUI
public void setMangagerUI(String managerUI)
Set the URI to the info about the managed resource.
managerUI
- The URI to the managed resource information.
setMangagerVariant
public void setMangagerVariant(String managerVariant)
Set the name of the variant of the system that manages this resource.
managerVariant
- The name of the management system.
setRenditionClass
public void setRenditionClass(String renditionClass)
Set the rendition class. The rendition class is derived from a defined
set of names. The value is series of colon separated tokens and parameters.
Defined values are:
Token Name | Description |
default | Specifies master document, no additional tokens allowed |
thumbnail | A simplied preview. Recommended order is: thumbnailformat:size:colorspace |
screen | Screen resolution |
proof | A review proof |
draft | A review rendition |
low-res | A low resolution, full size stand-in |
|
renditionClass
- The rendition class.
setRenditionParams
public void setRenditionParams(String params)
Set addition rendition params.
params
- Additional rendition parameters that are too complex for the rendition class.
setVersionID
public void setVersionID(String id)
Set the referenced resource's version id.
id
- The id of the reference document version.