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