org.apache.jempbox.xmp

Class ResourceEvent

public class ResourceEvent extends Object implements Elementable

This class represents a high level event that occured during the processing of this resource.

Version: $Revision: 1.2 $

Author: Ben Litchfield

Field Summary
static StringACTION_CONVERTED
A predefined action.
static StringACTION_COPIED
A predefined action.
static StringACTION_CREATED
A predefined action.
static StringACTION_CROPPED
A predefined action.
static StringACTION_EDITED
A predefined action.
static StringACTION_FILTERED
A predefined action.
static StringACTION_FORMATTED
A predefined action.
static StringACTION_MANAGED
A predefined action.
static StringACTION_PRINTED
A predefined action.
static StringACTION_PRODUCED
A predefined action.
static StringACTION_PUBLISHED
A predefined action.
static StringACTION_RESIZED
A predefined action.
static StringACTION_VERSION_UPDATED
A predefined action.
static StringNAMESPACE
Namespace for a resource event.
protected Elementparent
The DOM representation of this object.
Constructor Summary
ResourceEvent(Element parentElement)
Create a resource reference based on a existing parent property set.
ResourceEvent(XMPSchema schema)
Create resource event based on schema.
Method Summary
StringgetAction()
Get the action that occured.
ElementgetElement()
Get the underlying XML element.
StringgetInstanceID()
Get the referenced resource's instance 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.
StringgetParameters()
Get an additional description of the event.
StringgetSoftwareAgent()
Get the software that performed this action.
CalendargetWhen()
Get the date/time that this event occured.
voidsetAction(String action)
Set the action that this event represents.
voidsetInstanceID(String id)
Set the referenced resource's document instance 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.
voidsetParameters(String param)
Set some addition description to this event.
voidsetSoftwareAgent(String software)
Set the software that performed this operation.
voidsetWhen(Calendar when)
Set when the event occured.

Field Detail

ACTION_CONVERTED

public static final String ACTION_CONVERTED
A predefined action.

ACTION_COPIED

public static final String ACTION_COPIED
A predefined action.

ACTION_CREATED

public static final String ACTION_CREATED
A predefined action.

ACTION_CROPPED

public static final String ACTION_CROPPED
A predefined action.

ACTION_EDITED

public static final String ACTION_EDITED
A predefined action.

ACTION_FILTERED

public static final String ACTION_FILTERED
A predefined action.

ACTION_FORMATTED

public static final String ACTION_FORMATTED
A predefined action.

ACTION_MANAGED

public static final String ACTION_MANAGED
A predefined action.

ACTION_PRINTED

public static final String ACTION_PRINTED
A predefined action.

ACTION_PRODUCED

public static final String ACTION_PRODUCED
A predefined action.

ACTION_PUBLISHED

public static final String ACTION_PUBLISHED
A predefined action.

ACTION_RESIZED

public static final String ACTION_RESIZED
A predefined action.

ACTION_VERSION_UPDATED

public static final String ACTION_VERSION_UPDATED
A predefined action.

NAMESPACE

public static final String NAMESPACE
Namespace for a resource event.

parent

protected Element parent
The DOM representation of this object.

Constructor Detail

ResourceEvent

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

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

ResourceEvent

public ResourceEvent(XMPSchema schema)
Create resource event based on schema.

Parameters: schema The schema that this event will be part of.

Method Detail

getAction

public String getAction()
Get the action that occured. See the ACTION_XXX constants.

Returns: An action key, such as 'created' or 'printed'.

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 instance id.

Returns: The id of the reference document instance.

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.

getParameters

public String getParameters()
Get an additional description of the event.

Returns: Additional description of this event

getSoftwareAgent

public String getSoftwareAgent()
Get the software that performed this action.

Returns: The software that performed the action.

getWhen

public Calendar getWhen()
Get the date/time that this event occured.

Returns: The date of the event.

Throws: IOException If there is an error creating the date.

setAction

public void setAction(String action)
Set the action that this event represents. See the ACTION_XXX constants.

Parameters: action The action that this event represents.

setInstanceID

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

Parameters: id The id of the reference document instance.

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.

setParameters

public void setParameters(String param)
Set some addition description to this event.

Parameters: param The additional action parameters.

setSoftwareAgent

public void setSoftwareAgent(String software)
Set the software that performed this operation.

Parameters: software The name of the software that performed this action.

setWhen

public void setWhen(Calendar when)
Set when the event occured.

Parameters: when The date that the event occured.

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