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

Modifier and Type	Field and Description
public static final String	CONTRIBUTOR
public static final String	COVERAGE
public static final String	CREATOR
public static final String	DATE
public static final String	DESCRIPTION
public static final String	FORMAT
public static final String	IDENTIFIER
public static final String	LANGUAGE
public static final String	PUBLISHER
public static final String	RELATION
public static final String	RIGHTS
public static final String	SOURCE
public static final String	SUBJECT
public static final String	TITLE
public static final String	TYPE

Access	Constructor and Description
public	DublinCoreSchema(XMPMetadata The metadata to attach this schema metadata) Constructor of a Dublin Core schema with preferred prefix
public	DublinCoreSchema(XMPMetadata The metadata to attach this schema metadata, String The prefix to assign ownPrefix) Constructor of a Dublin Core schema with specified prefix

Method Summary

Modifier and Type	Method and Description
public void	addContributor(String Value to set properName) set contributor(s) to the resource (other than the authors)
public void	addCreator(String Value to add properName) set the author(s) of the resource
public void	addDate(Calendar Value to add date) Set date(s) that something interesting happened to the resource
public void	addDescription(String language concerned lang, String Value to add value) add a textual description of the content of the resource (multiple values may be present for different languages)
public void	addLanguage(String Value to set locale) Add language(s) used in this resource
public void	addPublisher(String Value to add properName) add publisher(s)
public void	addRelation(String Value to set text) Add relationships to other documents
public void	addRights(String Language concerned lang, String Value to set value) add informal rights statement, by language.
public void	addSubject(String Value to add text) add descriptive phrases or keywords that specify the topic of the content of the resource
public void	addTitle(String Language concerned lang, String Value to set value) set the title of the document, or the name given to the resource (by language)
public void	addType(String Value to set type) set the document type (novel, poem, ...)
public List<String>	Returns: List of contributors values getContributors() Return a String list of contributor(s)
public ArrayProperty	Returns: Contributor property getContributorsProperty() Return the Bag of contributor(s)
public String	Returns: Coverage value getCoverage() Return the value of the coverage
public TextType	Returns: Coverage property getCoverageProperty() Return the Coverage TextType Property
public List<String>	Returns: List of creators values getCreators() Return the creator(s) string value
public ArrayProperty	Returns: Creator property getCreatorsProperty() Return the Sequence of contributor(s)
public List<Calendar>	Returns: List of dates values getDates() Return a calendar list of date
public ArrayProperty	Returns: date property getDatesProperty() Return the sequence of date(s)
public String	Returns: Description value for specified language or null if it doesn't exist. getDescription(String The language wanted. lang) Return a language value for the description property.
public String	Returns: The description of this resource. getDescription() Get the default value for the description property.
public List<String>	Returns: The List of languages defined for the description property or null if it doesn't exist. getDescriptionLanguages() Return a list of languages defined in the description property.
public ArrayProperty	Returns: Description property getDescriptionProperty() Return the Lang alt Description
public String	Returns: the format value getFormat() return the file format value
public TextType	Returns: the format property getFormatProperty() Return the file format property
public String	Returns: the unique identifier value getIdentifier() return the unique identifier value of this resource
public TextType	Returns: the identifier property getIdentifierProperty() Return the unique identifier property of this resource
public List<String>	Returns: list of languages defined for language property getLanguages() Return the list of values defined in the DC language
public ArrayProperty	Returns: language property getLanguagesProperty() Return the bag DC language
public List<String>	Returns: list of values for publisher property getPublishers() Return the list of values defined in the DC publisher
public ArrayProperty	Returns: publisher property getPublishersProperty() Return the bag DC publisher
public List<String>	Returns: list of values for relation property getRelations() Return the list of values defined in the DC relation
public ArrayProperty	Returns: relation property getRelationsProperty() Return the bag DC relation
public String	Returns: The rights value for specified language or null if it doesn't exist. getRights(String language concerned. lang) Return a language value for the Rights property.
public String	Returns: the default rights value getRights() Return the default value for the Rights property.
public List<String>	Returns: list of rights languages values defined getRightsLanguages() Return a list of languages defined in Right property.
public ArrayProperty	Returns: rights property getRightsProperty() Return the Lang alt Rights
public String	Returns: value of source property getSource() return the source value of this resource
public TextType	Returns: source property getSourceProperty() Return the source property of this resource
public List<String>	Returns: the list of subject values getSubjects() Return the list of values defined in the DC Subject
public ArrayProperty	Returns: the subject property getSubjectsProperty() Return the bag DC Subject
public String	Returns: the title value for specified language getTitle(String the language concerned lang) Return a language value for the Title property
public String	Returns: The default title of this resource. getTitle() Get the default value for the title.
public List<String>	Returns: list of languages defined for title property getTitleLanguages() Return a list of languages defined in the Title property
public ArrayProperty	Returns: the title property getTitleProperty() Return the Lang alt Title
public List<String>	Returns: the value of type property getTypes() Return the list of values defined in the DC Type
public ArrayProperty	Returns: the type property getTypesProperty() Return the bag DC Type
public void	removeContributor(String properName)
public void	removeCreator(String name)
public void	removeDate(Calendar date)
public void	removeLanguage(String locale)
public void	removePublisher(String name)
public void	removeRelation(String text)
public void	removeSubject(String text)
public void	removeType(String type)
public void	setCoverage(String Value to set text) set the extent or scope of the resource
public void	setCoverageProperty(TextType Property to set text) set the extent or scope of the resource
public void	setDescription(String The description of this resource. value) Set the default value for the description.
public void	setFormat(String Value to set mimeType) set the file format used when saving the resource.
public void	setFormatProperty(MIMEType Property to set text) Set the unique identifier of the work from which this resource was derived
public void	setIdentifier(String Value to set text) Set the unique identifier of the resource
public void	setIdentifierProperty(TextType Property to set text) Set the unique identifier of the resource
public void	setSource(String Value to set text) Set the unique identifier of the work from which this resource was derived
public void	setSourceProperty(TextType Property to set text) Set the unique identifier of the work from which this resource was derived
public void	setTitle(String Language concerned lang, String Value to set value) set the title of the document, or the name given to the resource (by language)
public void	setTitle(String Value to set value) set default title

Inherited from 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

CONTRIBUTOR	back to summary
public static final String CONTRIBUTOR Annotations @PropertyType type:Text card:Bag

COVERAGE	back to summary
public static final String COVERAGE Annotations @PropertyType type:Text card:Simple

CREATOR	back to summary
public static final String CREATOR Annotations @PropertyType type:Text card:Seq

DATE	back to summary
public static final String DATE Annotations @PropertyType type:Date card:Seq

DESCRIPTION	back to summary
public static final String DESCRIPTION Annotations @PropertyType type:LangAlt card:Simple

FORMAT	back to summary
public static final String FORMAT Annotations @PropertyType type:MIMEType card:Simple

IDENTIFIER	back to summary
public static final String IDENTIFIER Annotations @PropertyType type:Text card:Simple

LANGUAGE	back to summary
public static final String LANGUAGE Annotations @PropertyType type:Text card:Bag

PUBLISHER	back to summary
public static final String PUBLISHER Annotations @PropertyType type:Text card:Bag

RELATION	back to summary
public static final String RELATION Annotations @PropertyType type:Text card:Bag

RIGHTS	back to summary
public static final String RIGHTS Annotations @PropertyType type:LangAlt card:Simple

SOURCE	back to summary
public static final String SOURCE Annotations @PropertyType type:Text card:Simple

SUBJECT	back to summary
public static final String SUBJECT Annotations @PropertyType type:Text card:Bag

TITLE	back to summary
public static final String TITLE Annotations @PropertyType type:LangAlt card:Simple

TYPE	back to summary
public static final String TYPE Annotations @PropertyType type:Text card:Bag

Method Detail

addContributor	back to summary
public void addContributor(String properName) set contributor(s) to the resource (other than the authors) Parameters properName:String Value to set

addContributor

back to summary

public void addContributor(String properName)

set contributor(s) to the resource (other than the authors)

Parameters

properName:String: Value to set

addCreator	back to summary
public void addCreator(String properName) set the author(s) of the resource Parameters properName:String Value to add

addCreator

back to summary

public void addCreator(String properName)

set the author(s) of the resource

Parameters

properName:String: Value to add

addDate	back to summary
public void addDate(Calendar date) Set date(s) that something interesting happened to the resource Parameters date:Calendar Value to add

addDescription	back to summary
public void addDescription(String lang, String value) add a textual description of the content of the resource (multiple values may be present for different languages) Parameters lang:String language concerned value:String Value to add

addDescription

back to summary

public void addDescription(String lang, String value)

add a textual description of the content of the resource (multiple values may be present for different languages)

Parameters

lang:String: language concerned
value:String: Value to add

addLanguage	back to summary
public void addLanguage(String locale) Add language(s) used in this resource Parameters locale:String Value to set

addLanguage

back to summary

public void addLanguage(String locale)

Add language(s) used in this resource

Parameters

locale:String: Value to set

addPublisher	back to summary
public void addPublisher(String properName) add publisher(s) Parameters properName:String Value to add

addPublisher

back to summary

public void addPublisher(String properName)

add publisher(s)

Parameters

properName:String: Value to add

addRelation	back to summary
public void addRelation(String text) Add relationships to other documents Parameters text:String Value to set

addRelation

back to summary

public void addRelation(String text)

Add relationships to other documents

Parameters

text:String: Value to set

addRights	back to summary
public void addRights(String lang, String value) add informal rights statement, by language. Parameters lang:String Language concerned value:String Value to set

addRights

back to summary

public void addRights(String lang, String value)

add informal rights statement, by language.

Parameters

lang:String: Language concerned
value:String: Value to set

addSubject	back to summary
public void addSubject(String text) add descriptive phrases or keywords that specify the topic of the content of the resource Parameters text:String Value to add

addSubject

back to summary

public void addSubject(String text)

add descriptive phrases or keywords that specify the topic of the content of the resource

Parameters

text:String: Value to add

addTitle back to summary

addTitle	back to summary
public void addTitle(String lang, String value) set the title of the document, or the name given to the resource (by language) Parameters lang:String Language concerned value:String Value to set See Also `DublinCoreSchema#setTitle(String)`

public void addTitle(String lang, String value)

set the title of the document, or the name given to the resource (by language)

Parameters

lang:String: Language concerned
value:String: Value to set

See Also

DublinCoreSchema#setTitle(String)

addType	back to summary
public void addType(String type) set the document type (novel, poem, ...) Parameters type:String Value to set

addType

back to summary

public void addType(String type)

set the document type (novel, poem, ...)

Parameters

type:String: Value to set

getContributors	back to summary
public List<String> getContributors() Return a String list of contributor(s) Returns:List<String> List of contributors values

getContributors

back to summary

public List<String> getContributors()

Return a String list of contributor(s)

Returns:List<String>: List of contributors values

getContributorsProperty	back to summary
public ArrayProperty getContributorsProperty() Return the Bag of contributor(s) Returns:ArrayProperty Contributor property

getContributorsProperty

back to summary

public ArrayProperty getContributorsProperty()

Return the Bag of contributor(s)

Returns:ArrayProperty: Contributor property

getCoverage	back to summary
public String getCoverage() Return the value of the coverage Returns:String Coverage value

getCoverage

back to summary

public String getCoverage()

Return the value of the coverage

Returns:String: Coverage value

getCoverageProperty	back to summary
public TextType getCoverageProperty() Return the Coverage TextType Property Returns:TextType Coverage property

getCoverageProperty

back to summary

public TextType getCoverageProperty()

Return the Coverage TextType Property

Returns:TextType: Coverage property

getCreators	back to summary
public List<String> getCreators() Return the creator(s) string value Returns:List<String> List of creators values

getCreators

back to summary

public List<String> getCreators()

Return the creator(s) string value

Returns:List<String>: List of creators values

getCreatorsProperty	back to summary
public ArrayProperty getCreatorsProperty() Return the Sequence of contributor(s) Returns:ArrayProperty Creator property

getCreatorsProperty

back to summary

public ArrayProperty getCreatorsProperty()

Return the Sequence of contributor(s)

Returns:ArrayProperty: Creator property

getDates	back to summary
public List<Calendar> getDates() Return a calendar list of date Returns:List<Calendar> List of dates values

getDates

back to summary

public List<Calendar> getDates()

Return a calendar list of date

Returns:List<Calendar>: List of dates values

getDatesProperty	back to summary
public ArrayProperty getDatesProperty() Return the sequence of date(s) Returns:ArrayProperty date property

getDatesProperty

back to summary

public ArrayProperty getDatesProperty()

Return the sequence of date(s)

Returns:ArrayProperty: date property

getDescription	back to summary
public String getDescription(String lang) throws BadFieldValueException Return a language value for the description property. Parameters lang:String The language wanted. Returns:String Description value for specified language or null if it doesn't exist. Exceptions BadFieldValueException: BadFieldValueException If the description property is not a multi-lingual property.

getDescription

back to summary

public String getDescription(String lang) throws BadFieldValueException

Return a language value for the description property.

Parameters

lang:String: The language wanted.

Returns:String

Description value for specified language or null if it doesn't exist.

Exceptions

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

getDescription	back to summary
public String getDescription() throws BadFieldValueException Get the default value for the description property. Returns:String The description of this resource. Exceptions BadFieldValueException: If the description property is not a multi-lingual property.

getDescription

back to summary

public String getDescription() throws BadFieldValueException

Get the default value for the description property.

Returns:String

The description of this resource.

Exceptions

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

getDescriptionLanguages	back to summary
public List<String> getDescriptionLanguages() throws BadFieldValueException Return a list of languages defined in the description property. Returns:List<String> The List of languages defined for the description property or null if it doesn't exist. Exceptions BadFieldValueException: If the description property is not a multi-lingual property.

getDescriptionLanguages

back to summary

public List<String> getDescriptionLanguages() throws BadFieldValueException

Return a list of languages defined in the description property.

Returns:List<String>

The List of languages defined for the description property or null if it doesn't exist.

Exceptions

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

getDescriptionProperty	back to summary
public ArrayProperty getDescriptionProperty() Return the Lang alt Description Returns:ArrayProperty Description property

getDescriptionProperty

back to summary

public ArrayProperty getDescriptionProperty()

Return the Lang alt Description

Returns:ArrayProperty: Description property

getFormat	back to summary
public String getFormat() return the file format value Returns:String the format value

getFormat

back to summary

public String getFormat()

return the file format value

Returns:String: the format value

getFormatProperty	back to summary
public TextType getFormatProperty() Return the file format property Returns:TextType the format property

getFormatProperty

back to summary

public TextType getFormatProperty()

Return the file format property

Returns:TextType: the format property

getIdentifier	back to summary
public String getIdentifier() return the unique identifier value of this resource Returns:String the unique identifier value

getIdentifier

back to summary

public String getIdentifier()

return the unique identifier value of this resource

Returns:String: the unique identifier value

getIdentifierProperty	back to summary
public TextType getIdentifierProperty() Return the unique identifier property of this resource Returns:TextType the identifier property

getIdentifierProperty

back to summary

public TextType getIdentifierProperty()

Return the unique identifier property of this resource

Returns:TextType: the identifier property

getLanguages	back to summary
public List<String> getLanguages() Return the list of values defined in the DC language Returns:List<String> list of languages defined for language property

getLanguages

back to summary

public List<String> getLanguages()

Return the list of values defined in the DC language

Returns:List<String>: list of languages defined for language property

getLanguagesProperty	back to summary
public ArrayProperty getLanguagesProperty() Return the bag DC language Returns:ArrayProperty language property

getLanguagesProperty

back to summary

public ArrayProperty getLanguagesProperty()

Return the bag DC language

Returns:ArrayProperty: language property

getPublishers	back to summary
public List<String> getPublishers() Return the list of values defined in the DC publisher Returns:List<String> list of values for publisher property

getPublishers

back to summary

public List<String> getPublishers()

Return the list of values defined in the DC publisher

Returns:List<String>: list of values for publisher property

getPublishersProperty

back to summary

public ArrayProperty getPublishersProperty()

Return the bag DC publisher

Returns:ArrayProperty: publisher property

getRelations

back to summary

public List<String> getRelations()

Return the list of values defined in the DC relation

Returns:List<String>: list of values for relation property

getRelationsProperty

back to summary

public ArrayProperty getRelationsProperty()

Return the bag DC relation

Returns:ArrayProperty: relation property

getRights

back to summary

public String getRights(String lang) throws BadFieldValueException

Return a language value for the Rights property.

Parameters

lang:String: language concerned.

Returns:String

The rights value for specified language or null if it doesn't exist.

Exceptions

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

getRights back to summary

public String getRights() throws BadFieldValueException

Return the default value for the Rights property.

Returns:String

the default rights value

Exceptions

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

See Also

DublinCoreSchema#getRights(String)

getRightsLanguages

back to summary

public List<String> getRightsLanguages() throws BadFieldValueException

Return a list of languages defined in Right property.

Returns:List<String>

list of rights languages values defined

Exceptions

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

getRightsProperty

back to summary

public ArrayProperty getRightsProperty()

Return the Lang alt Rights

Returns:ArrayProperty: rights property

getSource

back to summary

public String getSource()

return the source value of this resource

Returns:String: value of source property

getSourceProperty

back to summary

public TextType getSourceProperty()

Return the source property of this resource

Returns:TextType: source property

getSubjects

back to summary

public List<String> getSubjects()

Return the list of values defined in the DC Subject

Returns:List<String>: the list of subject values

getSubjectsProperty

back to summary

public ArrayProperty getSubjectsProperty()

Return the bag DC Subject

Returns:ArrayProperty: the subject property

getTitle

back to summary

public String getTitle(String lang) throws BadFieldValueException

Return a language value for the Title property

Parameters

lang:String: the language concerned

Returns:String

the title value for specified language

Exceptions

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

getTitle

back to summary

public String getTitle() throws BadFieldValueException

Get the default value for the title.

Returns:String

The default title of this resource.

Exceptions

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

getTitleLanguages

back to summary

public List<String> getTitleLanguages() throws BadFieldValueException

Return a list of languages defined in the Title property

Returns:List<String>

list of languages defined for title property

Exceptions

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

getTitleProperty

back to summary

public ArrayProperty getTitleProperty()

Return the Lang alt Title

Returns:ArrayProperty: the title property

getTypes

back to summary

public List<String> getTypes()

Return the list of values defined in the DC Type

Returns:List<String>: the value of type property

getTypesProperty

back to summary

public ArrayProperty getTypesProperty()

Return the bag DC Type

Returns:ArrayProperty: the type property

removeContributor	back to summary
public void removeContributor(String properName)

removeCreator	back to summary
public void removeCreator(String name)

removeLanguage	back to summary
public void removeLanguage(String locale)

removePublisher	back to summary
public void removePublisher(String name)

removeRelation	back to summary
public void removeRelation(String text)

removeSubject	back to summary
public void removeSubject(String text)

removeType	back to summary
public void removeType(String type)

setCoverage

back to summary

public void setCoverage(String text)

set the extent or scope of the resource

Parameters

text:String: Value to set

setCoverageProperty

back to summary

public void setCoverageProperty(TextType text)

set the extent or scope of the resource

Parameters

text:TextType: Property to set

setDescription

back to summary

public void setDescription(String value)

Set the default value for the description.

Parameters

value:String: The description of this resource.

setFormat

back to summary

public void setFormat(String mimeType)

set the file format used when saving the resource.

Parameters

mimeType:String: Value to set

setFormatProperty

back to summary

public void setFormatProperty(MIMEType text)

Set the unique identifier of the work from which this resource was derived

Parameters

text:MIMEType: Property to set

setIdentifier

back to summary

public void setIdentifier(String text)

Set the unique identifier of the resource

Parameters

text:String: Value to set

setIdentifierProperty

back to summary

public void setIdentifierProperty(TextType text)

Set the unique identifier of the resource

Parameters

text:TextType: Property to set

setSource

back to summary

public void setSource(String text)

Set the unique identifier of the work from which this resource was derived

Parameters

text:String: Value to set

setSourceProperty

back to summary

public void setSourceProperty(TextType text)

Set the unique identifier of the work from which this resource was derived

Parameters

text:TextType: Property to set

setTitle

back to summary

public void setTitle(String lang, String value)

set the title of the document, or the name given to the resource (by language)

Parameters

lang:String: Language concerned
value:String: Value to set

setTitle

back to summary

public void setTitle(String value)

set default title

Parameters

value:String: Value to set

public Class DublinCoreSchema

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail