Top Description Fields Constructors Methods
org.apache.xmpbox.schema

public Class PDFAIdentificationSchema

extends XMPSchema
Class Inheritance
Annotations
@StructuredType
preferedPrefix:pdfaid
namespace:http://www.aiim.org/pdfa/ns/id/
Imports
org.apache.xmpbox.XMPMetadata, org.apache.xmpbox.type.AbstractField, .Attribute, .BadFieldValueException, .Cardinality, .IntegerType, .PropertyType, .StructuredType, .TextType, .Types
Representation of PDF/A Identification Schema
Author
a183132

Field Summary

Modifier and TypeField and Description
public static final String
AMD

public static final String
CONFORMANCE

public static final String
PART

Constructor Summary

AccessConstructor and Description
public
PDFAIdentificationSchema(XMPMetadata
The metadata to attach this schema
metadata)

Constructor of a PDF/A Identification schema

public
PDFAIdentificationSchema(XMPMetadata metadata, String prefix)

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

Amendment Value
getAmd()

Give the PDFA Amendment Id (as an String)

public TextType

Returns:

Amendment property
getAmdProperty()

Give the property corresponding to the PDFA Amendment id

public String

Returns:

Amendment value
getAmendment()

Give the PDFAAmendmentId (as an String)

public String

Returns:

conformance id value
getConformance()

Give the Conformance id

public TextType

Returns:

conformance property
getConformanceProperty()

Give the property corresponding to the PDFA Conformance id

public Integer

Returns:

Part value (Integer) or null if it is missing
getPart()

Give the PDFAVersionId (as an integer)

public IntegerType

Returns:

Part property
getPartProperty()

Give the property corresponding to the PDFA Version id

public void
setAmd(String
The amendment identifier value to set
value)

Set the PDF/A amendment identifier

public void
setAmdProperty(TextType
The amendment identifier property to set
amd)

Set the PDF/A amendment identifier

public void
setConformance(String
The conformance level value to set
value)

Set the PDF/A conformance level

public void
setConformanceProperty(TextType
The conformance level property to set
conf)

Set the PDF/A conformance level

public void
setPart(Integer
The version Id property to set
value)

Set the PDF/A Version identifier (with an int)

public void
setPartProperty(IntegerType
set the PDF/A Version id property
part)

Set the PDF/A Version identifier

public void
setPartValueWithInt(int
The version Id value to set
value)

Set the PDFA Version identifier (with an int)

public void
setPartValueWithString(String
The version Id value to set
value)

Set the PDFA Version identifier (with string)

Inherited from org.apache.xmpbox.schema.XMPSchema:
addBagValueaddBagValueAsSimpleaddQualifiedBagValueaddSequenceDateValueAsSimpleaddUnqualifiedSequenceDateValueaddUnqualifiedSequenceValueaddUnqualifiedSequenceValuegetAboutAttributegetAboutValuegetAbstractPropertygetBooleanPropertygetBooleanPropertyValuegetBooleanPropertyValueAsSimplegetDatePropertygetDatePropertyValuegetDatePropertyValueAsSimplegetIntegerPropertygetIntegerPropertyValuegetIntegerPropertyValueAsSimplegetUnqualifiedArrayListgetUnqualifiedBagValueListgetUnqualifiedLanguagePropertyLanguagesValuegetUnqualifiedLanguagePropertyValuegetUnqualifiedSequenceDateValueListgetUnqualifiedSequenceValueListgetUnqualifiedTextPropertygetUnqualifiedTextPropertyValueinstanciateSimplemergeremoveUnqualifiedArrayValueremoveUnqualifiedBagValueremoveUnqualifiedSequenceDateValueremoveUnqualifiedSequenceValueremoveUnqualifiedSequenceValuereorganizeAltOrdersetAboutsetAboutAsSimplesetBooleanPropertysetBooleanPropertyValuesetBooleanPropertyValueAsSimplesetDatePropertysetDatePropertyValuesetDatePropertyValueAsSimplesetIntegerPropertysetIntegerPropertyValuesetIntegerPropertyValueAsSimplesetTextPropertysetTextPropertyValuesetTextPropertyValueAsSimplesetUnqualifiedLanguagePropertyValue

Field Detail

AMDback to summary
public static final String AMD
Annotations
@PropertyType
type:Text
card:Simple
CONFORMANCEback to summary
public static final String CONFORMANCE
Annotations
@PropertyType
type:Text
card:Simple
PARTback to summary
public static final String PART
Annotations
@PropertyType
type:Integer
card:Simple

Constructor Detail

PDFAIdentificationSchemaback to summary
public PDFAIdentificationSchema(XMPMetadata metadata)

Constructor of a PDF/A Identification schema

Parameters
metadata:XMPMetadata

The metadata to attach this schema

PDFAIdentificationSchemaback to summary
public PDFAIdentificationSchema(XMPMetadata metadata, String prefix)

Method Detail

getAmdback to summary
public String getAmd()

Give the PDFA Amendment Id (as an String)

Returns:String

Amendment Value

getAmdPropertyback to summary
public TextType getAmdProperty()

Give the property corresponding to the PDFA Amendment id

Returns:TextType

Amendment property

getAmendmentback to summary
public String getAmendment()

Give the PDFAAmendmentId (as an String)

Returns:String

Amendment value

getConformanceback to summary
public String getConformance()

Give the Conformance id

Returns:String

conformance id value

getConformancePropertyback to summary
public TextType getConformanceProperty()

Give the property corresponding to the PDFA Conformance id

Returns:TextType

conformance property

getPartback to summary
public Integer getPart()

Give the PDFAVersionId (as an integer)

Returns:Integer

Part value (Integer) or null if it is missing

getPartPropertyback to summary
public IntegerType getPartProperty()

Give the property corresponding to the PDFA Version id

Returns:IntegerType

Part property

setAmdback to summary
public void setAmd(String value)

Set the PDF/A amendment identifier

Parameters
value:String

The amendment identifier value to set

setAmdPropertyback to summary
public void setAmdProperty(TextType amd)

Set the PDF/A amendment identifier

Parameters
amd:TextType

The amendment identifier property to set

setConformanceback to summary
public void setConformance(String value) throws BadFieldValueException

Set the PDF/A conformance level

Parameters
value:String

The conformance level value to set

Exceptions
BadFieldValueException:
If Conformance Value not 'A', 'B' or 'U' (PDF/A-2 and PDF/A-3)
setConformancePropertyback to summary
public void setConformanceProperty(TextType conf) throws BadFieldValueException

Set the PDF/A conformance level

Parameters
conf:TextType

The conformance level property to set

Exceptions
BadFieldValueException:
If Conformance Value not 'A', 'B' or 'U' (PDF/A-2 and PDF/A-3)
setPartback to summary
public void setPart(Integer value)

Set the PDF/A Version identifier (with an int)

Parameters
value:Integer

The version Id property to set

setPartPropertyback to summary
public void setPartProperty(IntegerType part)

Set the PDF/A Version identifier

Parameters
part:IntegerType

set the PDF/A Version id property

setPartValueWithIntback to summary
public void setPartValueWithInt(int value)

Set the PDFA Version identifier (with an int)

Parameters
value:int

The version Id value to set

setPartValueWithStringback to summary
public void setPartValueWithString(String value)

Set the PDFA Version identifier (with string)

Parameters
value:String

The version Id value to set