org.apache.jempbox.xmp

Class ResourceRef

public class ResourceRef extends Object implements Elementable

This class represents a multiple part reference to a resource.

Version: $Revision: 1.3 $

Author: Ben Litchfield

Field Summary
protected Elementparent
The DOM representation of this object.
Constructor Summary
ResourceRef(Element parentElement)
Create a resource reference based on a existing parent property set.
Method Summary
StringgetDocumentID()
Get the referenced resource's document id.
ElementgetElement()
Get the underlying XML element.
StringgetInstanceID()
Get the referenced resource's id.
StringgetManager()
Get name of the asset management system that manages this resource.
StringgetManagerTo()
URI identifying the managed resource.
StringgetManagerUI()
URI to info about the managed resource.
StringgetManagerVariant()
Get name of the variant of asset management system that manages this resource.
StringgetRenditionClass()
Get the rendition class.
StringgetRenditionParams()
Get the extra rendition params.
StringgetVersionID()
Get the referenced resource's document version id.
voidsetDocumentID(String id)
Set the referenced resource's document id.
voidsetInstanceID(String id)
Set the referenced resource's id.
voidsetMangager(String manager)
Set the name of the system that manages this resource.
voidsetMangagerTo(String managerTo)
Set the URI to the managed resource.
voidsetMangagerUI(String managerUI)
Set the URI to the info about the managed resource.
voidsetMangagerVariant(String managerVariant)
Set the name of the variant of the system that manages this resource.
voidsetRenditionClass(String renditionClass)
Set the rendition class.
voidsetRenditionParams(String params)
Set addition rendition params.
voidsetVersionID(String id)
Set the referenced resource's version id.

Field Detail

parent

protected Element parent
The DOM representation of this object.

Constructor Detail

ResourceRef

public ResourceRef(Element parentElement)
Create a resource reference based on a existing parent property set.

Parameters: parentElement The parent element that will store the resource properties.

Method Detail

getDocumentID

public String getDocumentID()
Get the referenced resource's document id.

Returns: The id of the reference document.

getElement

public Element getElement()
Get the underlying XML element.

Returns: The XML element that this object represents.

getInstanceID

public String getInstanceID()
Get the referenced resource's id.

Returns: The id of the reference.

getManager

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

Returns: The name of a asset management system.

getManagerTo

public String getManagerTo()
URI identifying the managed resource.

Returns: The URI to resource.

getManagerUI

public String getManagerUI()
URI to info about the managed resource.

Returns: The URI to the resource info.

getManagerVariant

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

Returns: The name of a asset management system.

getRenditionClass

public String getRenditionClass()
Get the rendition class.

Returns: The value of the rendition class property.

See Also: ResourceRef

getRenditionParams

public String getRenditionParams()
Get the extra rendition params.

Returns: Additional rendition parameters.

getVersionID

public String getVersionID()
Get the referenced resource's document version id.

Returns: The id of the reference document version.

setDocumentID

public void setDocumentID(String id)
Set the referenced resource's document id.

Parameters: id The id of the reference document.

setInstanceID

public void setInstanceID(String id)
Set the referenced resource's id.

Parameters: id The id of the reference.

setMangager

public void setMangager(String manager)
Set the name of the system that manages this resource.

Parameters: manager The name of the management system.

setMangagerTo

public void setMangagerTo(String managerTo)
Set the URI to the managed resource.

Parameters: managerTo The URI to the managed resource.

setMangagerUI

public void setMangagerUI(String managerUI)
Set the URI to the info about the managed resource.

Parameters: 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.

Parameters: 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 NameDescription
defaultSpecifies master document, no additional tokens allowed
thumbnail A simplied preview. Recommended order is: thumbnailformat:size:colorspace
screenScreen resolution
proofA review proof
draftA review rendition
low-resA low resolution, full size stand-in

Parameters: renditionClass The rendition class.

setRenditionParams

public void setRenditionParams(String params)
Set addition rendition params.

Parameters: 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.

Parameters: id The id of the reference document version.