Package org.apache.xmpbox.schema
Class DublinCoreSchema
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.DublinCoreSchema
Representation of a DublinCore Schema
- Author:
- a183132
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
Fields inherited from class org.apache.xmpbox.type.AbstractStructuredType
STRUCTURE_ARRAY_NAME
-
Constructor Summary
ConstructorsConstructorDescriptionDublinCoreSchema
(XMPMetadata metadata) Constructor of a Dublin Core schema with preferred prefixDublinCoreSchema
(XMPMetadata metadata, String ownPrefix) Constructor of a Dublin Core schema with specified prefix -
Method Summary
Modifier and TypeMethodDescriptionvoid
addContributor
(String properName) set contributor(s) to the resource (other than the authors)void
addCreator
(String properName) set the author(s) of the resourcevoid
Set date(s) that something interesting happened to the resourcevoid
addDescription
(String lang, String value) add a textual description of the content of the resource (multiple values may be present for different languages)void
addLanguage
(String locale) Add language(s) used in this resourcevoid
addPublisher
(String properName) add publisher(s)void
addRelation
(String text) Add relationships to other documentsvoid
add informal rights statement, by language.void
addSubject
(String text) add descriptive phrases or keywords that specify the topic of the content of the resourcevoid
set the title of the document, or the name given to the resource (by language)void
set the document type (novel, poem, ...)Return a String list of contributor(s)Return the Bag of contributor(s)Return the value of the coverageReturn the Coverage TextType PropertyReturn the creator(s) string valueReturn the Sequence of contributor(s)getDates()
Return a calendar list of dateReturn the sequence of date(s)Get the default value for the description.getDescription
(String lang) Return a language value for description propertyReturn a list of languages defined in description propertyReturn the Lang alt Descriptionreturn the file format valueReturn the file format propertyreturn the unique identifier value of this resourceReturn the unique identifier property of this resourceReturn the list of values defined in the DC languageReturn the bag DC languageReturn the list of values defined in the DC publisherReturn the bag DC publisherReturn the list of values defined in the DC relationReturn the bag DC relationReturn the default value for Right propertyReturn a language value for Right propertyReturn a list of languages defined in Right propertyReturn the Lang alt Rightsreturn the source value of this resourceReturn the source property of this resourceReturn the list of values defined in the DC SubjectReturn the bag DC SubjectgetTitle()
Get the default value for the title.Return a language value for Title propertyReturn a list of languages defined in Title propertyReturn the Lang alt TitlegetTypes()
Return the list of values defined in the DC TypeReturn the bag DC Typevoid
removeContributor
(String properName) void
removeCreator
(String name) void
removeDate
(Calendar date) void
removeLanguage
(String locale) void
removePublisher
(String name) void
removeRelation
(String text) void
removeSubject
(String text) void
removeType
(String type) void
setCoverage
(String text) set the extent or scope of the resourcevoid
setCoverageProperty
(TextType text) set the extent or scope of the resourcevoid
setDescription
(String value) Set the default value for the description.void
set the file format used when saving the resource.void
setFormatProperty
(MIMEType text) Set the unique identifier of the work from which this resource was derivedvoid
setIdentifier
(String text) Set the unique identifier of the resourcevoid
Set the unique identifier of the resourcevoid
Set the unique identifier of the work from which this resource was derivedvoid
setSourceProperty
(TextType text) Set the unique identifier of the work from which this resource was derivedvoid
set default titlevoid
set the title of the document, or the name given to the resource (by language)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
-
Field Details
-
CONTRIBUTOR
- See Also:
-
COVERAGE
- See Also:
-
CREATOR
- See Also:
-
DATE
- See Also:
-
DESCRIPTION
- See Also:
-
FORMAT
- See Also:
-
IDENTIFIER
- See Also:
-
LANGUAGE
- See Also:
-
PUBLISHER
- See Also:
-
RELATION
- See Also:
-
RIGHTS
- See Also:
-
SOURCE
- See Also:
-
SUBJECT
- See Also:
-
TITLE
- See Also:
-
TYPE
- See Also:
-
-
Constructor Details
-
DublinCoreSchema
Constructor of a Dublin Core schema with preferred prefix- Parameters:
metadata
- The metadata to attach this schema
-
DublinCoreSchema
Constructor of a Dublin Core schema with specified prefix- Parameters:
metadata
- The metadata to attach this schemaownPrefix
- The prefix to assign
-
-
Method Details
-
addContributor
set contributor(s) to the resource (other than the authors)- Parameters:
properName
- Value to set
-
removeContributor
-
setCoverage
set the extent or scope of the resource- Parameters:
text
- Value to set
-
setCoverageProperty
set the extent or scope of the resource- Parameters:
text
- Property to set
-
addCreator
set the author(s) of the resource- Parameters:
properName
- Value to add
-
removeCreator
-
addDate
Set date(s) that something interesting happened to the resource- Parameters:
date
- Value to add
-
removeDate
-
addDescription
add a textual description of the content of the resource (multiple values may be present for different languages)- Parameters:
lang
- language concernedvalue
- Value to add
-
setDescription
Set the default value for the description.- Parameters:
value
- The description of this resource.
-
setFormat
set the file format used when saving the resource.- Parameters:
mimeType
- Value to set
-
setIdentifier
Set the unique identifier of the resource- Parameters:
text
- Value to set
-
setIdentifierProperty
Set the unique identifier of the resource- Parameters:
text
- Property to set
-
addLanguage
Add language(s) used in this resource- Parameters:
locale
- Value to set
-
removeLanguage
-
addPublisher
add publisher(s)- Parameters:
properName
- Value to add
-
removePublisher
-
addRelation
Add relationships to other documents- Parameters:
text
- Value to set
-
removeRelation
-
addRights
add informal rights statement, by language.- Parameters:
lang
- Language concernedvalue
- Value to set
-
setSource
Set the unique identifier of the work from which this resource was derived- Parameters:
text
- Value to set
-
setSourceProperty
Set the unique identifier of the work from which this resource was derived- Parameters:
text
- Property to set
-
setFormatProperty
Set the unique identifier of the work from which this resource was derived- Parameters:
text
- Property to set
-
addSubject
add descriptive phrases or keywords that specify the topic of the content of the resource- Parameters:
text
- Value to add
-
removeSubject
-
setTitle
set the title of the document, or the name given to the resource (by language)- Parameters:
lang
- Language concernedvalue
- Value to set
-
setTitle
set default title- Parameters:
value
- Value to set
-
addTitle
set the title of the document, or the name given to the resource (by language)- Parameters:
lang
- Language concernedvalue
- Value to set- See Also:
-
addType
set the document type (novel, poem, ...)- Parameters:
type
- Value to set
-
getContributorsProperty
Return the Bag of contributor(s)- Returns:
- Contributor property
-
getContributors
Return a String list of contributor(s)- Returns:
- List of contributors values
-
getCoverageProperty
Return the Coverage TextType Property- Returns:
- Coverage property
-
getCoverage
Return the value of the coverage- Returns:
- Coverage value
-
getCreatorsProperty
Return the Sequence of contributor(s)- Returns:
- Creator property
-
getCreators
Return the creator(s) string value- Returns:
- List of creators values
-
getDatesProperty
Return the sequence of date(s)- Returns:
- date property
-
getDates
Return a calendar list of date- Returns:
- List of dates values
-
getDescriptionProperty
Return the Lang alt Description- Returns:
- Description property
-
getDescriptionLanguages
Return a list of languages defined in description property- Returns:
- get List of languages defined for description property
-
getDescription
Return a language value for description property- Parameters:
lang
- The language wanted- Returns:
- Description value for specified language
-
getDescription
Get the default value for the description.- Returns:
- The description of this resource.
-
getFormatProperty
Return the file format property- Returns:
- the format property
-
getFormat
return the file format value- Returns:
- the format value
-
getIdentifierProperty
Return the unique identifier property of this resource- Returns:
- the identifier property
-
getIdentifier
return the unique identifier value of this resource- Returns:
- the unique identifier value
-
getLanguagesProperty
Return the bag DC language- Returns:
- language property
-
getLanguages
Return the list of values defined in the DC language- Returns:
- list of languages defined for language property
-
getPublishersProperty
Return the bag DC publisher- Returns:
- publisher property
-
getPublishers
Return the list of values defined in the DC publisher- Returns:
- list of values for publisher property
-
getRelationsProperty
Return the bag DC relation- Returns:
- relation property
-
getRelations
Return the list of values defined in the DC relation- Returns:
- list of values for relation property
-
getRightsProperty
Return the Lang alt Rights- Returns:
- rights property
-
getRightsLanguages
Return a list of languages defined in Right property- Returns:
- list of rights languages values defined
-
getRights
Return a language value for Right property- Parameters:
lang
- language concerned- Returns:
- the rights value for specified language
-
getRights
Return the default value for Right property- Returns:
- the default rights value
- See Also:
-
getSourceProperty
Return the source property of this resource- Returns:
- source property
-
getSource
return the source value of this resource- Returns:
- value of source property
-
getSubjectsProperty
Return the bag DC Subject- Returns:
- the subject property
-
getSubjects
Return the list of values defined in the DC Subject- Returns:
- the list of subject values
-
getTitleProperty
Return the Lang alt Title- Returns:
- the title property
-
getTitleLanguages
Return a list of languages defined in Title property- Returns:
- list of languages defined for title property
-
getTitle
Return a language value for Title property- Parameters:
lang
- the language concerned- Returns:
- the title value for specified language
-
getTitle
Get the default value for the title.- Returns:
- The default title of this resource.
-
getTypesProperty
Return the bag DC Type- Returns:
- the type property
-
getTypes
Return the list of values defined in the DC Type- Returns:
- the value of type property
-
removeType
-