org.apache.jempbox.xmp

Class XMPSchema

java.lang.Object

org.apache.jempbox.xmp.XMPSchema

Direct Known Subclasses:

XMPSchemaBasic, XMPSchemaBasicJobTicket, XMPSchemaDublinCore, XMPSchemaDynamicMedia, XMPSchemaIptc4xmpCore, XMPSchemaMediaManagement, XMPSchemaPagedText, XMPSchemaPDF, XMPSchemaPDFAField, XMPSchemaPDFAId, XMPSchemaPDFAProperty, XMPSchemaPDFASchema, XMPSchemaPDFAType, XMPSchemaPhotoshop, XMPSchemaRightsManagement

public class XMPSchema
extends Object

This class represents a metadata schema that can be stored in an XMP document. It handles all generic properties that are available. See subclasses for access to specific properties.

Version:

$Revision: 1.8 $

Author:

Ben Litchfield

Field Summary

Fields

Modifier and Type	Field and Description
static String	NS_NAMESPACE The standard xmlns namespace.
protected String	prefix The XML schema prefix.
protected Element	schema The DOM representation of this object.

Constructor Summary

Constructors

Constructor and Description
XMPSchema(Element element, String aPrefix) Create schema from an existing XML element.
XMPSchema(XMPMetadata parent, String namespaceName, String namespaceURI) Create a new blank schema that can be populated.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBagValue(String bagName, String bagValue) Add an entry to a bag property.
void	addSequenceDateValue(String seqName, Calendar date) Add a date sequence value to the list.
void	addSequenceValue(String seqName, Elementable seqValue) Add a new value to a sequence property.
void	addSequenceValue(String seqName, String seqValue) Add a new value to a sequence property.
String	getAbout() Get the RDF about attribute.
List<String>	getBagList(String bagName) Get all the values of the bag property.
Boolean	getBooleanProperty(String propertyName) Get the value of the property as a boolean.
Calendar	getDateProperty(String propertyName) Get the value of the property as a date.
Element	getElement() Get the XML element that is represented by this schema.
List<ResourceEvent>	getEventSequenceList(String seqName) Get a list of ResourceEvent objects.
Integer	getIntegerProperty(String propertyName) Get the value of the property as an integer.
String	getLanguageProperty(String propertyName, String language) Get the value of a multi-lingual property.
List<String>	getLanguagePropertyLanguages(String propertyName) Get a list of all languages that are currently defined for a specific property.
List<Calendar>	getSequenceDateList(String seqName) Get all the date values in a sequence property.
List<String>	getSequenceList(String seqName) Get all the values in a sequence property.
String	getTextProperty(String propertyName) Get the value of a simple text property.
Thumbnail	getThumbnailProperty(String propertyName, String language) Get the value of a multi-lingual property.
void	merge(XMPSchema xmpSchema) A basic schema merge, it merges bags and sequences and replace everything else.
void	removeBagValue(String bagName, String bagValue) Remove all matching entries with the given value from the bag.
void	removeSequenceDateValue(String seqName, Calendar date) Remove a date sequence value from the list.
void	removeSequenceValue(String seqName, Elementable seqValue) Remove a value from a sequence property.
void	removeSequenceValue(String seqName, String seqValue) Remove all matching values from a sequence property.
void	setAbout(String about) Set the RDF 'about' attribute.
void	setBooleanProperty(String propertyName, Boolean bool) Set the value of the property as a boolean.
void	setDateProperty(String propertyName, Calendar date) Set the value of the property as a date.
void	setIntegerProperty(String propertyName, Integer intValue) Set the value of the property as an integer.
void	setLanguageProperty(String propertyName, String language, String value) Set the value of a multi-lingual property.
void	setTextProperty(String propertyName, String propertyValue) Set a simple text property on the schema.
void	setThumbnailProperty(String propertyName, String language, Thumbnail value) Set the value of a multi-lingual property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NS_NAMESPACE

public static final String NS_NAMESPACE

The standard xmlns namespace.

See Also:

Constant Field Values

prefix

protected String prefix

The XML schema prefix.

schema

protected Element schema

The DOM representation of this object.

Constructor Detail

XMPSchema

public XMPSchema(XMPMetadata parent,
         String namespaceName,
         String namespaceURI)

Create a new blank schema that can be populated.

Parameters:

parent - The parent XMP document that this schema will be part of.

namespaceName - The name of the namespace, ie pdf,dc,...

namespaceURI - The URI of the namespace, ie "http://ns.adobe.com/pdf/1.3/"

XMPSchema

public XMPSchema(Element element,
         String aPrefix)

Create schema from an existing XML element.

Parameters:

element - The existing XML element.

aPrefix - The XML prefix.

Method Detail

getElement

public Element getElement()

Get the XML element that is represented by this schema.

Returns:

The root XML element of this schema.

getAbout

public String getAbout()

Get the RDF about attribute.

Returns:

The RDF 'about' attribute.

setAbout

public void setAbout(String about)

Set the RDF 'about' attribute. Passing in null will clear this attribute.

Parameters:

about - The new RFD about value.

setTextProperty

public void setTextProperty(String propertyName,
                   String propertyValue)

Set a simple text property on the schema.

Parameters:

propertyName - The name of the property, it must contain the namespace prefix, ie "pdf:Keywords"

propertyValue - The value for the property, can be any string. Passing null will remove the property.

getTextProperty

public String getTextProperty(String propertyName)

Get the value of a simple text property.

Parameters:

propertyName - The name of the property to get, it must include the namespace prefix. ie "pdf:Keywords".

Returns:

The value of the text property or the null if there is no value.

getDateProperty

public Calendar getDateProperty(String propertyName)
                         throws IOException

Get the value of the property as a date.

Parameters:

propertyName - The fully qualified property name for the date.

Returns:

The value of the property as a date.

Throws:

IOException - If there is an error converting the value to a date.

setDateProperty

public void setDateProperty(String propertyName,
                   Calendar date)

Set the value of the property as a date.

Parameters:

propertyName - The fully qualified property name for the date.

date - The date to set, or null to clear.

getBooleanProperty

public Boolean getBooleanProperty(String propertyName)

Get the value of the property as a boolean.

Parameters:

propertyName - The fully qualified property name for the boolean.

Returns:

The value of the property as a boolean.

setBooleanProperty

public void setBooleanProperty(String propertyName,
                      Boolean bool)

Set the value of the property as a boolean.

Parameters:

propertyName - The fully qualified property name for the boolean.

bool - The boolean to set, or null to clear.

getIntegerProperty

public Integer getIntegerProperty(String propertyName)

Get the value of the property as an integer.

Parameters:

propertyName - The fully qualified property name for the integer.

Returns:

The value of the property as an integer.

setIntegerProperty

public void setIntegerProperty(String propertyName,
                      Integer intValue)

Set the value of the property as an integer.

Parameters:

propertyName - The fully qualified property name for the integer.

intValue - The int to set, or null to clear.

removeBagValue

public void removeBagValue(String bagName,
                  String bagValue)

Remove all matching entries with the given value from the bag.

Parameters:

bagName - The name of the bag, it must include the namespace prefix. ie "pdf:Keywords".

bagValue - The value to remove from the bagList.

addBagValue

public void addBagValue(String bagName,
               String bagValue)

Add an entry to a bag property.

Parameters:

bagName - The name of the bag, it must include the namespace prefix. ie "pdf:Keywords".

bagValue - The value to add to the bagList.

getBagList

public List<String> getBagList(String bagName)

Get all the values of the bag property. This will return a list of java.lang.String objects, this is a read-only list.

Parameters:

bagName - The name of the bag property to get, it must include the namespace prefix. ie "pdf:Keywords"

Returns:

All of the values of the bag property in a list.

removeSequenceValue

public void removeSequenceValue(String seqName,
                       String seqValue)

Remove all matching values from a sequence property.

Parameters:

seqName - The name of the sequence property. It must include the namespace prefix. ie "pdf:Keywords".

seqValue - The value to remove from the list.

removeSequenceValue

public void removeSequenceValue(String seqName,
                       Elementable seqValue)

Remove a value from a sequence property. This will remove all entries from the list.

Parameters:

seqName - The name of the sequence property. It must include the namespace prefix. ie "pdf:Keywords".

seqValue - The value to remove from the list.

addSequenceValue

public void addSequenceValue(String seqName,
                    String seqValue)

Add a new value to a sequence property.

Parameters:

seqName - The name of the sequence property, it must include the namespace prefix. ie "pdf:Keywords"

seqValue - The value to add to the sequence.

addSequenceValue

public void addSequenceValue(String seqName,
                    Elementable seqValue)

Add a new value to a sequence property.

Parameters:

seqName - The name of the sequence property, it must include the namespace prefix. ie "pdf:Keywords"

seqValue - The value to add to the sequence.

getSequenceList

public List<String> getSequenceList(String seqName)

Get all the values in a sequence property.

Parameters:

seqName - The name of the sequence property, it must include the namespace prefix. ie "pdf:Keywords".

Returns:

A read-only list of java.lang.String objects or null if the property does not exist.

getEventSequenceList

public List<ResourceEvent> getEventSequenceList(String seqName)

Get a list of ResourceEvent objects.

Parameters:

seqName - The name of the sequence to retrieve.

Returns:

A list of ResourceEvent objects or null if they do not exist.

removeSequenceDateValue

public void removeSequenceDateValue(String seqName,
                           Calendar date)

Remove a date sequence value from the list.

Parameters:

seqName - The name of the sequence property, it must include the namespace prefix. ie "pdf:Keywords"

date - The date to remove from the sequence property.

addSequenceDateValue

public void addSequenceDateValue(String seqName,
                        Calendar date)

Add a date sequence value to the list.

Parameters:

seqName - The name of the sequence property, it must include the namespace prefix. ie "pdf:Keywords"

date - The date to add to the sequence property.

getSequenceDateList

public List<Calendar> getSequenceDateList(String seqName)
                                   throws IOException

Get all the date values in a sequence property.

Parameters:

seqName - The name of the sequence property, it must include the namespace prefix. ie "pdf:Keywords".

Returns:

A read-only list of java.util.Calendar objects or null if the property does not exist.

Throws:

IOException - If there is an error converting the value to a date.

setLanguageProperty

public void setLanguageProperty(String propertyName,
                       String language,
                       String value)

Set the value of a multi-lingual property.

Parameters:

propertyName - The name of the property, it must include the namespace prefix. ie "pdf:Keywords"

language - The language code of the value. If null then "x-default" is assumed.

value - The value of the property in the specified language.

getLanguageProperty

public String getLanguageProperty(String propertyName,
                         String language)

Get the value of a multi-lingual property.

Parameters:

propertyName - The name of the property, it must include the namespace prefix. ie "pdf:Keywords"

language - The language code of the value. If null then "x-default" is assumed.

Returns:

The value of the language property.

setThumbnailProperty

public void setThumbnailProperty(String propertyName,
                        String language,
                        Thumbnail value)

Set the value of a multi-lingual property.

Parameters:

propertyName - The name of the property, it must include the namespace prefix. ie "pdf:Keywords"

language - The language code of the value. If null then "x-default" is assumed.

value - The value of the property in the specified language.

getThumbnailProperty

public Thumbnail getThumbnailProperty(String propertyName,
                             String language)

Get the value of a multi-lingual property.

Parameters:

propertyName - The name of the property, it must include the namespace prefix. ie "pdf:Keywords"

language - The language code of the value. If null then "x-default" is assumed.

Returns:

The value of the language property.

getLanguagePropertyLanguages

public List<String> getLanguagePropertyLanguages(String propertyName)

Get a list of all languages that are currently defined for a specific property.

Parameters:

propertyName - The name of the property, it must include the namespace prefix. ie "pdf:Keywords"

Returns:

A list of all languages, this will return an non-null empty list if none have been defined.

merge

public void merge(XMPSchema xmpSchema)
           throws IOException

A basic schema merge, it merges bags and sequences and replace everything else.

Parameters:

xmpSchema - The schema to merge.

Throws:

IOException - If there is an error during the merge.