org.apache.jempbox.xmp
public class XMPSchema extends Object
Version: $Revision: 1.8 $
Field Summary | |
---|---|
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 | |
---|---|
XMPSchema(XMPMetadata parent, String namespaceName, String namespaceURI)
Create a new blank schema that can be populated.
| |
XMPSchema(Element element, String aPrefix)
Create schema from an existing XML element.
|
Method Summary | |
---|---|
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, String seqValue)
Add a new value to a sequence property.
|
void | addSequenceValue(String seqName, Elementable seqValue)
Add a new value to a sequence property.
|
String | getAbout()
Get the RDF about attribute.
|
List | 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 | 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 | getLanguagePropertyLanguages(String propertyName)
Get a list of all languages that are currently defined for a specific
property.
|
List | getSequenceDateList(String seqName)
Get all the date values in a sequence property.
|
List | 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, String seqValue)
Remove all matching values from a sequence property.
|
void | removeSequenceValue(String seqName, Elementable seqValue)
Remove a value 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.
|
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/"
Parameters: element The existing XML element. aPrefix The XML prefix.
Parameters: bagName The name of the bag, it must include the namespace prefix. ie "pdf:Keywords". bagValue The value to add to the bagList.
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.
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.
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.
Returns: The RDF 'about' attribute.
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.
Parameters: propertyName The fully qualified property name for the boolean.
Returns: The value of the property as a boolean.
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.
Returns: The root XML element of this schema.
Parameters: seqName The name of the sequence to retrieve.
Returns: A list of ResourceEvent objects or null if they do not exist.
Parameters: propertyName The fully qualified property name for the integer.
Returns: The value of the property as an integer.
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.
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.
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.
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.
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.
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.
Parameters: xmpSchema The schema to merge.
Throws: IOException If there is an error during the merge.
Parameters: bagName The name of the bag, it must include the namespace prefix. ie "pdf:Keywords". bagValue The value to remove from the bagList.
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.
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.
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.
Parameters: about The new RFD about value.
Parameters: propertyName The fully qualified property name for the boolean. bool The boolean to set, or null to clear.
Parameters: propertyName The fully qualified property name for the date. date The date to set, or null to clear.
Parameters: propertyName The fully qualified property name for the integer. intValue The int to set, or null to clear.
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.
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.
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.