io.konik.carriage.pdfbox.xmp

Class XMPSchemaZugferd1p0

java.lang.Object

org.apache.xmpbox.type.AbstractField

org.apache.xmpbox.type.AbstractComplexProperty

org.apache.xmpbox.type.AbstractStructuredType

org.apache.xmpbox.schema.XMPSchema

org.apache.xmpbox.schema.PDFAExtensionSchema

io.konik.carriage.pdfbox.xmp.XMPSchemaZugferd1p0

public class XMPSchemaZugferd1p0
extends org.apache.xmpbox.schema.PDFAExtensionSchema

The Class XMP ZUGFeRD Schema.

This is an example of the result

<pre><code> <rdf:Description rdf:about="" xmlns:zf="urn:ferd:pdfa:CrossIndustryDocument:invoice:1p0#"> <zf:ConformanceLevel>BASIC</zf:ConformanceLevel> <zf:DocumentFileName>ZUGFeRD-invoice.xml</zf:DocumentFileName> <zf:DocumentType>INVOICE</zf:DocumentType> <zf:Version>1.0</zf:Version> </rdf:Description> </code></pre>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFORMANCE_LEVEL The Constant CONFORMANCE_LEVEL.
static String	DOCUMENT_FILE_NAME The Constant DOCUMENT_FILE_NAME.
static String	DOCUMENT_TYPE The Constant DOCUMENT_TYPE.
static String	VALUE_TYPE
static String	VERSION The Constant VERSION.

Fields inherited from class org.apache.xmpbox.schema.PDFAExtensionSchema

SCHEMAS

Fields inherited from class org.apache.xmpbox.type.AbstractStructuredType

STRUCTURE_ARRAY_NAME

Constructor Summary

Constructors

Constructor and Description
XMPSchemaZugferd1p0(org.apache.xmpbox.XMPMetadata metadata) Instantiates a new XMP schema ZUGFeRD 1.0.
XMPSchemaZugferd1p0(org.apache.xmpbox.XMPMetadata metadata, String customPrefix) Instantiates a new XMP schema zugferd1p0.

Method Summary

Modifier and Type	Method and Description
String	getConformanceLevel() Gets the ZUGFeRD conformance level.
org.apache.xmpbox.type.TextType	getConformanceLevelProperty() Gets the ZUGFeRD conformance level.
String	getDocumentFileName() Gets the ZUGFeRD document file name.
org.apache.xmpbox.type.TextType	getDocumentFileNameProperty() Gets the ZUGFeRD document file name.
String	getDocumentType() Gets the ZUGFeRD document type.
org.apache.xmpbox.type.TextType	getDocumentTypeProperty() Gets the ZUGFeRD document type.
String	getVersion() Gets the version.
org.apache.xmpbox.type.TextType	getVersionProperty() Gets the version.
void	setConformanceLevel(String conformanceLevel) Sets the ZUGFeRD conformance level.
void	setDocumentFileName(String documentFileName) Sets the ZUGFeRD document file name.
void	setDocumentType(String documentType) Sets the ZUGFeRD document type.
void	setVersion(String version) Sets the version.

Methods inherited from class org.apache.xmpbox.schema.PDFAExtensionSchema

getSchemasProperty

Methods inherited from class org.apache.xmpbox.schema.XMPSchema

addBagValue, addBagValueAsSimple, addQualifiedBagValue, addSequenceDateValueAsSimple, addUnqualifiedSequenceDateValue, addUnqualifiedSequenceValue, addUnqualifiedSequenceValue, getAboutAttribute, getAboutValue, getAbstractProperty, getBooleanProperty, getBooleanPropertyValue, getBooleanPropertyValueAsSimple, getDateProperty, getDatePropertyValue, getDatePropertyValueAsSimple, getIntegerProperty, getIntegerPropertyValue, getIntegerPropertyValueAsSimple, getUnqualifiedArrayList, getUnqualifiedBagValueList, getUnqualifiedLanguagePropertyLanguagesValue, getUnqualifiedLanguagePropertyValue, getUnqualifiedSequenceDateValueList, getUnqualifiedSequenceValueList, getUnqualifiedTextProperty, getUnqualifiedTextPropertyValue, instanciateSimple, merge, removeUnqualifiedArrayValue, removeUnqualifiedBagValue, removeUnqualifiedSequenceDateValue, removeUnqualifiedSequenceValue, removeUnqualifiedSequenceValue, reorganizeAltOrder, setAbout, setAboutAsSimple, setBooleanProperty, setBooleanPropertyValue, setBooleanPropertyValueAsSimple, setDateProperty, setDatePropertyValue, setDatePropertyValueAsSimple, setIntegerProperty, setIntegerPropertyValue, setIntegerPropertyValueAsSimple, setTextProperty, setTextPropertyValue, setTextPropertyValueAsSimple, setUnqualifiedLanguagePropertyValue

Methods inherited from class org.apache.xmpbox.type.AbstractStructuredType

addSimpleProperty, createArrayProperty, createTextType, getDatePropertyAsCalendar, getNamespace, getPreferedPrefix, getPrefix, getPropertyValueAsString, setNamespace, setPrefix

Methods inherited from class org.apache.xmpbox.type.AbstractComplexProperty

addNamespace, addProperty, getAllNamespacesWithPrefix, getAllProperties, getArrayProperty, getContainer, getFirstEquivalentProperty, getNamespacePrefix, getProperty, removeProperty

Methods inherited from class org.apache.xmpbox.type.AbstractField

containsAttribute, getAllAttributes, getAttribute, getMetadata, getPropertyName, removeAttribute, setAttribute, setPropertyName

Methods inherited from class java.lang.Object

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

Field Detail

CONFORMANCE_LEVEL

public static final String CONFORMANCE_LEVEL

The Constant CONFORMANCE_LEVEL.

See Also:

Constant Field Values

DOCUMENT_FILE_NAME

public static final String DOCUMENT_FILE_NAME

The Constant DOCUMENT_FILE_NAME.

See Also:

Constant Field Values

DOCUMENT_TYPE

public static final String DOCUMENT_TYPE

The Constant DOCUMENT_TYPE.

See Also:

Constant Field Values

VALUE_TYPE

public static final String VALUE_TYPE

See Also:

Constant Field Values

VERSION

public static final String VERSION

The Constant VERSION.

See Also:

Constant Field Values

Constructor Detail

XMPSchemaZugferd1p0

public XMPSchemaZugferd1p0(org.apache.xmpbox.XMPMetadata metadata)

Instantiates a new XMP schema ZUGFeRD 1.0.

Set sensible default values

Parameters:

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

XMPSchemaZugferd1p0

public XMPSchemaZugferd1p0(org.apache.xmpbox.XMPMetadata metadata,
                           String customPrefix)

Instantiates a new XMP schema zugferd1p0.

Parameters:

metadata - the metadata

customPrefix - the user defined prefix that should differ from zf

Method Detail

getConformanceLevel

public String getConformanceLevel()

Gets the ZUGFeRD conformance level.

Possible values are: BASIC, COMFORT, EXTENDED

Returns:

the ZUGFeRD conformance level

getConformanceLevelProperty

public org.apache.xmpbox.type.TextType getConformanceLevelProperty()

Gets the ZUGFeRD conformance level.

Possible values are: BASIC, COMFORT, EXTENDED

Returns:

the ZUGFeRD conformance level

getDocumentFileName

public String getDocumentFileName()

Gets the ZUGFeRD document file name.

Currently known value is ZUGFeRD-invoice.xml

Returns:

the document file name

getDocumentFileNameProperty

public org.apache.xmpbox.type.TextType getDocumentFileNameProperty()

Gets the ZUGFeRD document file name.

Currently known value is ZUGFeRD-invoice.xml

Returns:

the document file name

getDocumentType

public String getDocumentType()

Gets the ZUGFeRD document type.

As of writing only INVOICE is supported

Returns:

the document type

getDocumentTypeProperty

public org.apache.xmpbox.type.TextType getDocumentTypeProperty()

Gets the ZUGFeRD document type.

As of writing only INVOICE is supported

Returns:

the ZUGFeRD document type

getVersion

public String getVersion()

Gets the version.

Returns:

the version

getVersionProperty

public org.apache.xmpbox.type.TextType getVersionProperty()

Gets the version.

Returns:

the version

setConformanceLevel

public void setConformanceLevel(String conformanceLevel)

Sets the ZUGFeRD conformance level.

Possible values are: BASIC, COMFORT, EXTENDED

Parameters:

conformanceLevel - the ZUGFeRD conformance level

setDocumentFileName

public void setDocumentFileName(String documentFileName)

Sets the ZUGFeRD document file name.

Currently known value is ZUGFeRD-invoice.xml

Parameters:

documentFileName - the new document file name

setDocumentType

public void setDocumentType(String documentType)

Sets the ZUGFeRD document type.

As of writing only INVOICE is supported

Parameters:

documentType - the new document file name

setVersion

public void setVersion(String version)

Sets the version.

Parameters:

version - the new version