Apache PDFBox 3.0.4 · org.apache.xmpbox.schema.XMPSchema

Access	Constructor and Description
public	XMPSchema(XMPMetadata The parent XMP metadata that this schema will be part of. metadata, String The URI of the namespace, e.g. "http://ns.adobe.com/pdf/1.3/" namespaceURI, String The field prefix of the namespace. prefix, String The property name. name) Create a new blank schema that can be populated.
public	XMPSchema(XMPMetadata The parent XMP metadata that this schema will be part of. metadata) Create a new blank schema that can be populated.
public	XMPSchema(XMPMetadata The parent XMP metadata that this schema will be part of. metadata, String The field prefix of the namespace. prefix) Create a new blank schema that can be populated.
public	XMPSchema(XMPMetadata The parent XMP metadata that this schema will be part of. metadata, String The URI of the namespace, e.g. "http://ns.adobe.com/pdf/1.3/" namespaceURI, String The field prefix of the namespace. prefix) Create a new blank schema that can be populated.

Method Summary

Modifier and Type	Method and Description
public void	addBagValue(String The name of the sequence property, it must include the namespace prefix, e.g. "pdf:Keywords" qualifiedSeqName, AbstractField The value to add to the bag. seqValue) Add a new value to a bag property.
public void	addBagValueAsSimple(String the local name of property simpleName, String the string value to add bagValue) add a bag value property on the schema, using the current prefix.
public void	addQualifiedBagValue(String The name of the bag without the namespace prefix simpleName, String The value to add to the bagList. bagValue) Add an entry to a bag property.
public void	addSequenceDateValueAsSimple(String the local name of the property simpleName, Calendar the value to add date) Add a date sequence value to the list using the current prefix
public void	addUnqualifiedSequenceDateValue(String The name of the sequence property, it must include the namespace prefix, e.g. "pdf:Keywords" seqName, Calendar The date to add to the sequence property. date) Add a date sequence value to the list.
public void	addUnqualifiedSequenceValue(String The name of the sequence property without the namespace prefix simpleSeqName, String The value to add to the sequence. seqValue) Add a new value to a sequence property.
public void	addUnqualifiedSequenceValue(String The name of the sequence property, it must include the namespace prefix, e.g. "pdf:Keywords" seqName, AbstractField The value to add to the sequence. seqValue) Add a new value to a sequence property.
public Attribute	Returns: The RDF 'about' attribute. getAboutAttribute() Get the RDF about attribute
public String	Returns: The RDF 'about' value. If there is no rdf:about attribute, an empty string is returned. getAboutValue() Get the RDF about value.
public AbstractField	Returns: The generic simple type property according to its qualified name getAbstractProperty(String Full qualified name of property wanted qualifiedName) Retrieve a generic simple type property
public BooleanType	Returns: boolean Type property or null if it doesn't exist. getBooleanProperty(String the full qualified name of property wanted qualifiedName) Get a BooleanType property by its name.
public Boolean	Returns: The value of the property as a Boolean, or null if the property does not exist. getBooleanPropertyValue(String The fully qualified property name for the Boolean. qualifiedName) Get the value of the property as a Boolean.
public Boolean	Returns: The value of the property as a boolean or null if the property does not exist. getBooleanPropertyValueAsSimple(String the local name of property wanted simpleName) Get a simple boolean property value on the schema, using the current prefix.
public DateType	Returns: Date Type property getDateProperty(String The name of the property to get, it must include the namespace prefix, e.g. "pdf:Keywords". qualifiedName) Get a Date property by its name
public Calendar	Returns: The value of the property as a date or null if it doesn't exist. getDatePropertyValue(String The fully qualified property name for the date. qualifiedName) Get the value of the property as a date.
public Calendar	Returns: The value of the property as a calendar. getDatePropertyValueAsSimple(String the local name of the property to get simpleName) Get a simple date property value on the schema, using the current prefix.
public IntegerType	Returns: Integer Type property or null if it doesn't exist. getIntegerProperty(String the full qualified name of property wanted qualifiedName) Get the Integer property by its name
public Integer	Returns: The value of the property as an integer or null if it doesn't exist. getIntegerPropertyValue(String The fully qualified property name for the integer. qualifiedName) Get the value of the property as an integer.
public Integer	Returns: The value of the property as an integer or null if it doesn't exist. getIntegerPropertyValueAsSimple(String the local name of property wanted simpleName) Get a simple integer property value on the schema, using the current prefix.
public List<AbstractField>	Returns: List of properties contained in the array property. getUnqualifiedArrayList(String The property name without namespace. name) Get an AbstractField list corresponding to the content of an array property.
public List<String>	Returns: All values of the bag property in a list. getUnqualifiedBagValueList(String The bag name. bagName) Get all the values of the bag property.
public List<String>	Returns: A list of all languages, this will return an non-null empty list if none have been defined, and null if the property doesn't exist. getUnqualifiedLanguagePropertyLanguagesValue(String The name of the property, it must include the namespace prefix, e.g. "pdf:Keywords". name) Get a list of all languages that are currently defined for a specific property.
public String	Returns: The value of the language property or null if it doesn't exist. getUnqualifiedLanguagePropertyValue(String The name of the property, without the namespace prefix. name, String The language code of the value. If null then "x-default" is assumed. expectedLanguage) Get the value of a multi-lingual property.
public List<Calendar>	Returns: A read-only list of java.util.Calendar objects or null if the property does not exist. getUnqualifiedSequenceDateValueList(String The name of the sequence property, it must include the namespace prefix, e.g. "pdf:Keywords". seqName) Get all the date values in a sequence property.
public List<String>	Returns: A read-only list of java.lang.String objects or null if the property does not exist. getUnqualifiedSequenceValueList(String The name of the sequence property without namespace prefix. seqName) Get all the values in a sequence property.
public TextType	Returns: The Text Type property wanted or null if not found. getUnqualifiedTextProperty(String The property name. name) Get a TextProperty Type by its name
public String	Returns: The value of the text property or null if there is no value. getUnqualifiedTextPropertyValue(String The property name. name) Get the value of a simple text property.
protected AbstractSimpleProperty	instanciateSimple(String propertyName, Object value)
private void	internalAddBagValue(String qualifiedBagName, String bagValue)
public void	merge(XMPSchema The schema to merge. xmpSchema) A basic schema merge, it merges bags and sequences and replace everything else.
private boolean	mergeComplexProperty(Iterator<AbstractField> itNewValues, ArrayProperty arrayProperty)
private void	removeUnqualifiedArrayValue(String arrayName, String the field value fieldValue) Generic array property removing
public void	removeUnqualifiedArrayValue(String the name of the property concerned arrayName, AbstractField the elementable field value fieldValue) Generic method to remove a field from an array with an Elementable Object
public void	removeUnqualifiedBagValue(String The bag name. bagName, String The value to remove from the bagList. bagValue) Remove all matching entries with the given value from the bag.
public void	removeUnqualifiedSequenceDateValue(String The name of the sequence property, it must include the namespace prefix, e.g. "pdf:Keywords" seqName, Calendar The date to remove from the sequence property. date) Remove a date sequence value from the list.
public void	removeUnqualifiedSequenceValue(String The name of the sequence property. It must include the namespace prefix, e.g. "pdf:Keywords". qualifiedSeqName, String The value to remove from the list. seqValue) Remove all matching values from a sequence property.
public void	removeUnqualifiedSequenceValue(String The name of the sequence property. It must include the namespace prefix, e.g. "pdf:Keywords". qualifiedSeqName, AbstractField The value to remove from the list. seqValue) Remove a value from a sequence property.
public void	reorganizeAltOrder(ComplexPropertyContainer The property to reorganize alt) Method used to place the 'x-default' value in first in Language alternatives as said in xmp spec
public void	setAbout(Attribute the well-formed attribute about) Set the RDF 'about' attribute
public void	setAboutAsSimple(String The new RFD about value. about) Set the RDF 'about' attribute.
public void	setBooleanProperty(BooleanType the booleanType property bool) Set a BooleanType property
public void	setBooleanPropertyValue(String The fully qualified property name for the boolean. qualifiedName, Boolean The boolean to set, or null to clear. bool) Set the value of the property as a boolean.
public void	setBooleanPropertyValueAsSimple(String the name of the property without prefix simpleName, Boolean The value for the property, can be any string. Passing null will remove the property. bool) Set a simple Boolean property on the schema, using the current prefix.
public void	setDateProperty(DateType The DateType Property date) Set a new DateProperty
public void	setDatePropertyValue(String The fully qualified property name for the date. qualifiedName, Calendar The date to set, or null to clear. date) Set the value of the property as a date.
public void	setDatePropertyValueAsSimple(String the name of the property without prefix simpleName, Calendar The calendar value for the property, can be any string. Passing null will remove the property. date) Set a simple Date property on the schema, using the current prefix.
public void	setIntegerProperty(IntegerType The Integer Type property prop) Add an integerProperty
public void	setIntegerPropertyValue(String The fully qualified property name for the integer. qualifiedName, Integer The int to set, or null to clear. intValue) Set the value of the property as an integer.
public void	setIntegerPropertyValueAsSimple(String the name of the property without prefix simpleName, Integer The value for the property, can be any string. Passing null will remove the property. intValue) Set a simple Integer property on the schema, using the current prefix.
private void	setSpecifiedSimpleTypeProperty(Types type, String qualifiedName, Object propertyValue)
private void	setSpecifiedSimpleTypeProperty(AbstractSimpleProperty The Property to add prop) Add a SimpleProperty to this schema
public void	setTextProperty(TextType The text property to add prop) Set TextType property
public void	setTextPropertyValue(String The name of the property, it must contain the namespace prefix, ie "pdf:Keywords" qualifiedName, String The value for the property, can be any string. Passing null will remove the property. propertyValue) Set a simple text property on the schema.
public void	setTextPropertyValueAsSimple(String the name of the property without prefix simpleName, String The value for the property, can be any string. Passing null will remove the property. propertyValue) Set a simple text property on the schema, using the current prefix.
public void	setUnqualifiedLanguagePropertyValue(String The name of the property, it must include the namespace prefix, e.g. "pdf:Keywords" name, String The language code of the value. If null then "x-default" is assumed. language, String The value of the property in the specified language. value) Set the value of a multi-lingual property.

Inherited from org.apache.xmpbox.type.AbstractStructuredType:: addSimpleProperty createArrayProperty createTextType getDatePropertyAsCalendar getNamespace getPreferedPrefix getPrefix getPropertyValueAsString setNamespace setPrefix

Method Detail

addBagValue	back to summary
public void addBagValue(String qualifiedSeqName, AbstractField seqValue) Add a new value to a bag property. Parameters qualifiedSeqName:String The name of the sequence property, it must include the namespace prefix, e.g. "pdf:Keywords" seqValue:AbstractField The value to add to the bag.

addBagValue

back to summary

public void addBagValue(String qualifiedSeqName, AbstractField seqValue)

Add a new value to a bag property.

Parameters

qualifiedSeqName:String: The name of the sequence property, it must include the namespace prefix, e.g. "pdf:Keywords"
seqValue:AbstractField: The value to add to the bag.

addBagValueAsSimple	back to summary
public void addBagValueAsSimple(String simpleName, String bagValue) add a bag value property on the schema, using the current prefix. Parameters simpleName:String the local name of property bagValue:String the string value to add

addBagValueAsSimple

back to summary

public void addBagValueAsSimple(String simpleName, String bagValue)

add a bag value property on the schema, using the current prefix.

Parameters

simpleName:String: the local name of property
bagValue:String: the string value to add

addQualifiedBagValue	back to summary
public void addQualifiedBagValue(String simpleName, String bagValue) Add an entry to a bag property. Parameters simpleName:String The name of the bag without the namespace prefix bagValue:String The value to add to the bagList.

addQualifiedBagValue

back to summary

public void addQualifiedBagValue(String simpleName, String bagValue)

Add an entry to a bag property.

Parameters

simpleName:String: The name of the bag without the namespace prefix
bagValue:String: The value to add to the bagList.

addSequenceDateValueAsSimple	back to summary
public void addSequenceDateValueAsSimple(String simpleName, Calendar date) Add a date sequence value to the list using the current prefix Parameters simpleName:String the local name of the property date:Calendar the value to add

addUnqualifiedSequenceDateValue	back to summary
public void addUnqualifiedSequenceDateValue(String seqName, Calendar date) Add a date sequence value to the list. Parameters seqName:String The name of the sequence property, it must include the namespace prefix, e.g. "pdf:Keywords" date:Calendar The date to add to the sequence property.

addUnqualifiedSequenceValue	back to summary
public void addUnqualifiedSequenceValue(String simpleSeqName, String seqValue) Add a new value to a sequence property. Parameters simpleSeqName:String The name of the sequence property without the namespace prefix seqValue:String The value to add to the sequence.

addUnqualifiedSequenceValue

back to summary

public void addUnqualifiedSequenceValue(String simpleSeqName, String seqValue)

Add a new value to a sequence property.

Parameters

simpleSeqName:String: The name of the sequence property without the namespace prefix
seqValue:String: The value to add to the sequence.

addUnqualifiedSequenceValue	back to summary
public void addUnqualifiedSequenceValue(String seqName, AbstractField seqValue) Add a new value to a sequence property. Parameters seqName:String The name of the sequence property, it must include the namespace prefix, e.g. "pdf:Keywords" seqValue:AbstractField The value to add to the sequence.

addUnqualifiedSequenceValue

back to summary

public void addUnqualifiedSequenceValue(String seqName, AbstractField seqValue)

Add a new value to a sequence property.

Parameters

seqName:String: The name of the sequence property, it must include the namespace prefix, e.g. "pdf:Keywords"
seqValue:AbstractField: The value to add to the sequence.

getAboutAttribute	back to summary
public Attribute getAboutAttribute() Get the RDF about attribute Returns:Attribute The RDF 'about' attribute.

getAboutAttribute

back to summary

public Attribute getAboutAttribute()

Get the RDF about attribute

Returns:Attribute: The RDF 'about' attribute.

getAboutValue	back to summary
public String getAboutValue() Get the RDF about value. Returns:String The RDF 'about' value. If there is no rdf:about attribute, an empty string is returned.

getAboutValue

back to summary

public String getAboutValue()

Get the RDF about value.

Returns:String: The RDF 'about' value. If there is no rdf:about attribute, an empty string is returned.

getAbstractProperty	back to summary
public AbstractField getAbstractProperty(String qualifiedName) Retrieve a generic simple type property Parameters qualifiedName:String Full qualified name of property wanted Returns:AbstractField The generic simple type property according to its qualified name

getAbstractProperty

back to summary

public AbstractField getAbstractProperty(String qualifiedName)

Retrieve a generic simple type property

Parameters

qualifiedName:String: Full qualified name of property wanted

Returns:AbstractField

The generic simple type property according to its qualified name

getBooleanProperty	back to summary
public BooleanType getBooleanProperty(String qualifiedName) throws BadFieldValueException Get a BooleanType property by its name. Parameters qualifiedName:String the full qualified name of property wanted Returns:BooleanType boolean Type property or null if it doesn't exist. Exceptions BadFieldValueException: If the property is not a boolean property.

getBooleanProperty

back to summary

public BooleanType getBooleanProperty(String qualifiedName) throws BadFieldValueException

Get a BooleanType property by its name.

Parameters

qualifiedName:String: the full qualified name of property wanted

Returns:BooleanType

boolean Type property or null if it doesn't exist.

Exceptions

BadFieldValueException:: If the property is not a boolean property.

getBooleanPropertyValue	back to summary
public Boolean getBooleanPropertyValue(String qualifiedName) throws BadFieldValueException Get the value of the property as a Boolean. If you want to use this value like a condition, you must do a null check before. Parameters qualifiedName:String The fully qualified property name for the Boolean. Returns:Boolean The value of the property as a Boolean, or null if the property does not exist. Exceptions BadFieldValueException: If the property is not a boolean property.

getBooleanPropertyValue

back to summary

public Boolean getBooleanPropertyValue(String qualifiedName) throws BadFieldValueException

Get the value of the property as a Boolean. If you want to use this value like a condition, you must do a null check before.

Parameters

qualifiedName:String: The fully qualified property name for the Boolean.

Returns:Boolean

The value of the property as a Boolean, or null if the property does not exist.

Exceptions

BadFieldValueException:: If the property is not a boolean property.

getBooleanPropertyValueAsSimple	back to summary
public Boolean getBooleanPropertyValueAsSimple(String simpleName) throws BadFieldValueException Get a simple boolean property value on the schema, using the current prefix. Parameters simpleName:String the local name of property wanted Returns:Boolean The value of the property as a boolean or null if the property does not exist. Exceptions BadFieldValueException: If the property is not a boolean property.

getBooleanPropertyValueAsSimple

back to summary

public Boolean getBooleanPropertyValueAsSimple(String simpleName) throws BadFieldValueException

Get a simple boolean property value on the schema, using the current prefix.

Parameters

simpleName:String: the local name of property wanted

Returns:Boolean

The value of the property as a boolean or null if the property does not exist.

Exceptions

BadFieldValueException:: If the property is not a boolean property.

getDateProperty	back to summary
public DateType getDateProperty(String qualifiedName) throws BadFieldValueException Get a Date property by its name Parameters qualifiedName:String The name of the property to get, it must include the namespace prefix, e.g. "pdf:Keywords". Returns:DateType Date Type property Exceptions BadFieldValueException: If the property is not a date property.

getDateProperty

back to summary

public DateType getDateProperty(String qualifiedName) throws BadFieldValueException

Get a Date property by its name

Parameters

qualifiedName:String: The name of the property to get, it must include the namespace prefix, e.g. "pdf:Keywords".

Returns:DateType

Date Type property

Exceptions

BadFieldValueException:: If the property is not a date property.

getDatePropertyValue	back to summary
public Calendar getDatePropertyValue(String qualifiedName) throws BadFieldValueException Get the value of the property as a date. Parameters qualifiedName:String The fully qualified property name for the date. Returns:Calendar The value of the property as a date or null if it doesn't exist. Exceptions BadFieldValueException: If the property is not a date property.

getDatePropertyValue

back to summary

public Calendar getDatePropertyValue(String qualifiedName) throws BadFieldValueException

Get the value of the property as a date.

Parameters

qualifiedName:String: The fully qualified property name for the date.

Returns:Calendar

The value of the property as a date or null if it doesn't exist.

Exceptions

BadFieldValueException:: If the property is not a date property.

getDatePropertyValueAsSimple	back to summary
public Calendar getDatePropertyValueAsSimple(String simpleName) throws BadFieldValueException Get a simple date property value on the schema, using the current prefix. Parameters simpleName:String the local name of the property to get Returns:Calendar The value of the property as a calendar. Exceptions BadFieldValueException: If the property is not a date property.

getDatePropertyValueAsSimple

back to summary

public Calendar getDatePropertyValueAsSimple(String simpleName) throws BadFieldValueException

Get a simple date property value on the schema, using the current prefix.

Parameters

simpleName:String: the local name of the property to get

Returns:Calendar

The value of the property as a calendar.

Exceptions

BadFieldValueException:: If the property is not a date property.

getIntegerProperty	back to summary
public IntegerType getIntegerProperty(String qualifiedName) throws BadFieldValueException Get the Integer property by its name Parameters qualifiedName:String the full qualified name of property wanted Returns:IntegerType Integer Type property or null if it doesn't exist. Exceptions BadFieldValueException: If the property is not an integer property.

getIntegerProperty

back to summary

public IntegerType getIntegerProperty(String qualifiedName) throws BadFieldValueException

Get the Integer property by its name

Parameters

qualifiedName:String: the full qualified name of property wanted

Returns:IntegerType

Integer Type property or null if it doesn't exist.

Exceptions

BadFieldValueException:: If the property is not an integer property.

getIntegerPropertyValue	back to summary
public Integer getIntegerPropertyValue(String qualifiedName) throws BadFieldValueException Get the value of the property as an integer. Parameters qualifiedName:String The fully qualified property name for the integer. Returns:Integer The value of the property as an integer or null if it doesn't exist. Exceptions BadFieldValueException: If the property is not an integer property.

getIntegerPropertyValue

back to summary

public Integer getIntegerPropertyValue(String qualifiedName) throws BadFieldValueException

Get the value of the property as an integer.

Parameters

qualifiedName:String: The fully qualified property name for the integer.

Returns:Integer

The value of the property as an integer or null if it doesn't exist.

Exceptions

BadFieldValueException:: If the property is not an integer property.

getIntegerPropertyValueAsSimple	back to summary
public Integer getIntegerPropertyValueAsSimple(String simpleName) throws BadFieldValueException Get a simple integer property value on the schema, using the current prefix. Parameters simpleName:String the local name of property wanted Returns:Integer The value of the property as an integer or null if it doesn't exist. Exceptions BadFieldValueException: If the property is not an integer property.

getIntegerPropertyValueAsSimple

back to summary

public Integer getIntegerPropertyValueAsSimple(String simpleName) throws BadFieldValueException

Get a simple integer property value on the schema, using the current prefix.

Parameters

simpleName:String: the local name of property wanted

Returns:Integer

The value of the property as an integer or null if it doesn't exist.

Exceptions

BadFieldValueException:: If the property is not an integer property.

getUnqualifiedArrayList	back to summary
public List<AbstractField> getUnqualifiedArrayList(String name) throws BadFieldValueException Get an AbstractField list corresponding to the content of an array property. Parameters name:String The property name without namespace. Returns:List<AbstractField> List of properties contained in the array property. Exceptions BadFieldValueException: If the property with the requested name isn't an array.

getUnqualifiedArrayList

back to summary

public List<AbstractField> getUnqualifiedArrayList(String name) throws BadFieldValueException

Get an AbstractField list corresponding to the content of an array property.

Parameters

name:String: The property name without namespace.

Returns:List<AbstractField>

List of properties contained in the array property.

Exceptions

BadFieldValueException:: If the property with the requested name isn't an array.

getUnqualifiedBagValueList	back to summary
public List<String> getUnqualifiedBagValueList(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:String The bag name. Returns:List<String> All values of the bag property in a list.

getUnqualifiedBagValueList

back to summary

public List<String> getUnqualifiedBagValueList(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:String: The bag name.

Returns:List<String>

All values of the bag property in a list.

getUnqualifiedLanguagePropertyLanguagesValue	back to summary
public List<String> getUnqualifiedLanguagePropertyLanguagesValue(String name) throws BadFieldValueException Get a list of all languages that are currently defined for a specific property. Parameters name:String The name of the property, it must include the namespace prefix, e.g. "pdf:Keywords". Returns:List<String> A list of all languages, this will return an non-null empty list if none have been defined, and null if the property doesn't exist. Exceptions BadFieldValueException: If the property is not a multi-lingual property.

getUnqualifiedLanguagePropertyLanguagesValue

back to summary

public List<String> getUnqualifiedLanguagePropertyLanguagesValue(String name) throws BadFieldValueException

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

Parameters

name:String: The name of the property, it must include the namespace prefix, e.g. "pdf:Keywords".

Returns:List<String>

A list of all languages, this will return an non-null empty list if none have been defined, and null if the property doesn't exist.

Exceptions

BadFieldValueException:: If the property is not a multi-lingual property.

getUnqualifiedLanguagePropertyValue	back to summary
public String getUnqualifiedLanguagePropertyValue(String name, String expectedLanguage) throws BadFieldValueException Get the value of a multi-lingual property. Parameters name:String The name of the property, without the namespace prefix. expectedLanguage:String The language code of the value. If null then "x-default" is assumed. Returns:String The value of the language property or null if it doesn't exist. Exceptions BadFieldValueException: If the property is not a multi-lingual property.

getUnqualifiedLanguagePropertyValue

back to summary

public String getUnqualifiedLanguagePropertyValue(String name, String expectedLanguage) throws BadFieldValueException

Get the value of a multi-lingual property.

Parameters

name:String: The name of the property, without the namespace prefix.
expectedLanguage:String: The language code of the value. If null then "x-default" is assumed.

Returns:String

The value of the language property or null if it doesn't exist.

Exceptions

BadFieldValueException:: If the property is not a multi-lingual property.

getUnqualifiedSequenceDateValueList	back to summary
public List<Calendar> getUnqualifiedSequenceDateValueList(String seqName) Get all the date values in a sequence property. Parameters seqName:String The name of the sequence property, it must include the namespace prefix, e.g. "pdf:Keywords". Returns:List<Calendar> A read-only list of java.util.Calendar objects or null if the property does not exist.

getUnqualifiedSequenceDateValueList

back to summary

public List<Calendar> getUnqualifiedSequenceDateValueList(String seqName)

Get all the date values in a sequence property.

Parameters

seqName:String: The name of the sequence property, it must include the namespace prefix, e.g. "pdf:Keywords".

Returns:List<Calendar>

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

getUnqualifiedSequenceValueList	back to summary
public List<String> getUnqualifiedSequenceValueList(String seqName) Get all the values in a sequence property. Parameters seqName:String The name of the sequence property without namespace prefix. Returns:List<String> A read-only list of java.lang.String objects or null if the property does not exist.

getUnqualifiedSequenceValueList

back to summary

public List<String> getUnqualifiedSequenceValueList(String seqName)

Get all the values in a sequence property.

Parameters

seqName:String: The name of the sequence property without namespace prefix.

Returns:List<String>

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

getUnqualifiedTextProperty	back to summary
public TextType getUnqualifiedTextProperty(String name) throws BadFieldValueException Get a TextProperty Type by its name Parameters name:String The property name. Returns:TextType The Text Type property wanted or null if not found. Exceptions BadFieldValueException: If the property is not a text property.

getUnqualifiedTextProperty

back to summary

public TextType getUnqualifiedTextProperty(String name) throws BadFieldValueException

Get a TextProperty Type by its name

Parameters

name:String: The property name.

Returns:TextType

The Text Type property wanted or null if not found.

Exceptions

BadFieldValueException:: If the property is not a text property.

getUnqualifiedTextPropertyValue	back to summary
public String getUnqualifiedTextPropertyValue(String name) throws BadFieldValueException Get the value of a simple text property. Parameters name:String The property name. Returns:String The value of the text property or null if there is no value. Exceptions BadFieldValueException: If the property is not a text property.

getUnqualifiedTextPropertyValue

back to summary

public String getUnqualifiedTextPropertyValue(String name) throws BadFieldValueException

Get the value of a simple text property.

Parameters

name:String: The property name.

Returns:String

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

Exceptions

BadFieldValueException:: If the property is not a text property.

instanciateSimple	back to summary
protected AbstractSimpleProperty instanciateSimple(String propertyName, Object value)

internalAddBagValue	back to summary
private void internalAddBagValue(String qualifiedBagName, String bagValue)

merge	back to summary
public void merge(XMPSchema xmpSchema) throws IOException A basic schema merge, it merges bags and sequences and replace everything else. Parameters xmpSchema:XMPSchema The schema to merge. Exceptions IOException: If there is an error during the merge.

merge

back to summary

public void merge(XMPSchema xmpSchema) throws IOException

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

Parameters

xmpSchema:XMPSchema: The schema to merge.

Exceptions

IOException:: If there is an error during the merge.

mergeComplexProperty	back to summary
private boolean mergeComplexProperty(Iterator<AbstractField> itNewValues, ArrayProperty arrayProperty)

removeUnqualifiedArrayValue	back to summary
private void removeUnqualifiedArrayValue(String arrayName, String fieldValue) Generic array property removing Parameters fieldValue:String the field value

removeUnqualifiedArrayValue

back to summary

private void removeUnqualifiedArrayValue(String arrayName, String fieldValue)

Generic array property removing

Parameters

fieldValue:String: the field value

removeUnqualifiedArrayValue	back to summary
public void removeUnqualifiedArrayValue(String arrayName, AbstractField fieldValue) Generic method to remove a field from an array with an Elementable Object Parameters arrayName:String the name of the property concerned fieldValue:AbstractField the elementable field value

removeUnqualifiedArrayValue

back to summary

public void removeUnqualifiedArrayValue(String arrayName, AbstractField fieldValue)

Generic method to remove a field from an array with an Elementable Object

Parameters

arrayName:String: the name of the property concerned
fieldValue:AbstractField: the elementable field value

removeUnqualifiedBagValue	back to summary
public void removeUnqualifiedBagValue(String bagName, String bagValue) Remove all matching entries with the given value from the bag. Parameters bagName:String The bag name. bagValue:String The value to remove from the bagList.

removeUnqualifiedBagValue

back to summary

public void removeUnqualifiedBagValue(String bagName, String bagValue)

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

Parameters

bagName:String: The bag name.
bagValue:String: The value to remove from the bagList.

removeUnqualifiedSequenceDateValue	back to summary
public void removeUnqualifiedSequenceDateValue(String seqName, Calendar date) Remove a date sequence value from the list. Parameters seqName:String The name of the sequence property, it must include the namespace prefix, e.g. "pdf:Keywords" date:Calendar The date to remove from the sequence property.

removeUnqualifiedSequenceValue	back to summary
public void removeUnqualifiedSequenceValue(String qualifiedSeqName, String seqValue) Remove all matching values from a sequence property. Parameters qualifiedSeqName:String The name of the sequence property. It must include the namespace prefix, e.g. "pdf:Keywords". seqValue:String The value to remove from the list.

removeUnqualifiedSequenceValue

back to summary

public void removeUnqualifiedSequenceValue(String qualifiedSeqName, String seqValue)

Remove all matching values from a sequence property.

Parameters

qualifiedSeqName:String: The name of the sequence property. It must include the namespace prefix, e.g. "pdf:Keywords".
seqValue:String: The value to remove from the list.

removeUnqualifiedSequenceValue	back to summary
public void removeUnqualifiedSequenceValue(String qualifiedSeqName, AbstractField seqValue) Remove a value from a sequence property. This will remove all entries from the list. Parameters qualifiedSeqName:String The name of the sequence property. It must include the namespace prefix, e.g. "pdf:Keywords". seqValue:AbstractField The value to remove from the list.

removeUnqualifiedSequenceValue

back to summary

public void removeUnqualifiedSequenceValue(String qualifiedSeqName, AbstractField seqValue)

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

Parameters

qualifiedSeqName:String: The name of the sequence property. It must include the namespace prefix, e.g. "pdf:Keywords".
seqValue:AbstractField: The value to remove from the list.

reorganizeAltOrder	back to summary
public void reorganizeAltOrder(ComplexPropertyContainer alt) Method used to place the 'x-default' value in first in Language alternatives as said in xmp spec Parameters alt:ComplexPropertyContainer The property to reorganize

reorganizeAltOrder

back to summary

public void reorganizeAltOrder(ComplexPropertyContainer alt)

Method used to place the 'x-default' value in first in Language alternatives as said in xmp spec

Parameters

alt:ComplexPropertyContainer: The property to reorganize

setAbout	back to summary
public void setAbout(Attribute about) throws BadFieldValueException Set the RDF 'about' attribute Parameters about:Attribute the well-formed attribute Exceptions BadFieldValueException: Bad Attribute name (not corresponding to about attribute)

setAbout

back to summary

public void setAbout(Attribute about) throws BadFieldValueException

Set the RDF 'about' attribute

Parameters

about:Attribute: the well-formed attribute

Exceptions

BadFieldValueException:: Bad Attribute name (not corresponding to about attribute)

setAboutAsSimple	back to summary
public void setAboutAsSimple(String about) Set the RDF 'about' attribute. Passing in null will clear this attribute. Parameters about:String The new RFD about value.

setAboutAsSimple

back to summary

public void setAboutAsSimple(String about)

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

Parameters

about:String: The new RFD about value.

setBooleanProperty	back to summary
public void setBooleanProperty(BooleanType bool) Set a BooleanType property Parameters bool:BooleanType the booleanType property

setBooleanProperty

back to summary

public void setBooleanProperty(BooleanType bool)

Set a BooleanType property

Parameters

bool:BooleanType: the booleanType property

setBooleanPropertyValue	back to summary
public void setBooleanPropertyValue(String qualifiedName, Boolean bool) Set the value of the property as a boolean. Parameters qualifiedName:String The fully qualified property name for the boolean. bool:Boolean The boolean to set, or null to clear.

setBooleanPropertyValue

back to summary

public void setBooleanPropertyValue(String qualifiedName, Boolean bool)

Set the value of the property as a boolean.

Parameters

qualifiedName:String: The fully qualified property name for the boolean.
bool:Boolean: The boolean to set, or null to clear.

setBooleanPropertyValueAsSimple	back to summary
public void setBooleanPropertyValueAsSimple(String simpleName, Boolean bool) Set a simple Boolean property on the schema, using the current prefix. Parameters simpleName:String the name of the property without prefix bool:Boolean The value for the property, can be any string. Passing null will remove the property.

setBooleanPropertyValueAsSimple

back to summary

public void setBooleanPropertyValueAsSimple(String simpleName, Boolean bool)

Set a simple Boolean property on the schema, using the current prefix.

Parameters

simpleName:String: the name of the property without prefix
bool:Boolean: The value for the property, can be any string. Passing null will remove the property.

setDateProperty	back to summary
public void setDateProperty(DateType date) Set a new DateProperty Parameters date:DateType The DateType Property

setDateProperty

back to summary

public void setDateProperty(DateType date)

Set a new DateProperty

Parameters

date:DateType: The DateType Property

setIntegerProperty

back to summary

public void setIntegerProperty(IntegerType prop)

Add an integerProperty

Parameters

prop:IntegerType: The Integer Type property

setIntegerPropertyValue

back to summary

public void setIntegerPropertyValue(String qualifiedName, Integer intValue)

Set the value of the property as an integer.

Parameters

qualifiedName:String: The fully qualified property name for the integer.
intValue:Integer: The int to set, or null to clear.

setIntegerPropertyValueAsSimple

back to summary

public void setIntegerPropertyValueAsSimple(String simpleName, Integer intValue)

Set a simple Integer property on the schema, using the current prefix.

Parameters

simpleName:String: the name of the property without prefix
intValue:Integer: The value for the property, can be any string. Passing null will remove the property.

setSpecifiedSimpleTypeProperty	back to summary
private void setSpecifiedSimpleTypeProperty(Types type, String qualifiedName, Object propertyValue)

setSpecifiedSimpleTypeProperty

back to summary

private void setSpecifiedSimpleTypeProperty(AbstractSimpleProperty prop)

Add a SimpleProperty to this schema

Parameters

prop:AbstractSimpleProperty: The Property to add

setTextProperty

back to summary

public void setTextProperty(TextType prop)

Set TextType property

Parameters

prop:TextType: The text property to add

setTextPropertyValue

back to summary

public void setTextPropertyValue(String qualifiedName, String propertyValue)

Set a simple text property on the schema.

Parameters

qualifiedName:String: The name of the property, it must contain the namespace prefix, ie "pdf:Keywords"
propertyValue:String: The value for the property, can be any string. Passing null will remove the property.

setTextPropertyValueAsSimple

back to summary

public void setTextPropertyValueAsSimple(String simpleName, String propertyValue)

Set a simple text property on the schema, using the current prefix.

Parameters

simpleName:String: the name of the property without prefix
propertyValue:String: The value for the property, can be any string. Passing null will remove the property.

setUnqualifiedLanguagePropertyValue

back to summary

public void setUnqualifiedLanguagePropertyValue(String name, String language, String value)

Set the value of a multi-lingual property.

Parameters

name:String: The name of the property, it must include the namespace prefix, e.g. "pdf:Keywords"
language:String: The language code of the value. If null then "x-default" is assumed.
value:String: The value of the property in the specified language.

public Class XMPSchema

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail