Package org.apache.jempbox.xmp
Class XMPSchemaDublinCore
java.lang.Object
org.apache.jempbox.xmp.XMPSchema
org.apache.jempbox.xmp.XMPSchemaDublinCore
Define XMP properties used with the Dublin Core specification.
- Version:
- $Revision: 1.3 $
- Author:
- Ben Litchfield
-
Field Summary
FieldsFields inherited from class org.apache.jempbox.xmp.XMPSchema
NS_NAMESPACE, prefix, schema
-
Constructor Summary
ConstructorsConstructorDescriptionXMPSchemaDublinCore
(XMPMetadata parent) Construct a new blank Dublin Core schema.XMPSchemaDublinCore
(Element element, String prefix) Constructor from existing XML element. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addContributor
(String contributor) Add a contributor to the list of contributors.void
addCreator
(String creator) Add a creator.void
Add a date of interest to this schema.void
addLanguage
(String language) Add a language to the list of languages.void
addPublisher
(String publisher) Add a publisher to the list of publishers.void
addRelation
(String relation) Add a relation to the list of relationships.void
addSubject
(String subject) Add a subject to the list of subjects.void
Add a type to the bag of types of this resource.Get the complete list of contributors.Get the coverage property.Get a complete list of creators.getDates()
Get a list of all dates of interest to this resource.Get the default value for the description.getDescription
(String language) Get the description in a specific language.Get a list of all languages that a description exists for.Get the format property.Get the resource id.Get the complete list of languages.Get the complete list of publishers.Get the complete list of relationships.Get the default value for the rights of this document.Get the rights in a specific language.Get a list of all languages that a rights description exists for.Get the resource source id.Get the complete list of subjects.getTitle()
Get the default value for the title.Get the title in a specific language.Get a list of all languages that a title exists for.getTypes()
Get the list of types for this resource.void
removeContributor
(String contributor) Remove a contributor from the list of contributors.void
removeCreator
(String creator) Remove a creator from the list of creators.void
removeDate
(Calendar date) Remove a date from the list of 'interesting' dates.void
removeLanguage
(String language) Remove a language from the list of languages.void
removePublisher
(String publisher) Remove a publisher from the list of publishers.void
removeRelation
(String relation) Remove a relation from the list of relationships.void
removeSubject
(String subject) Remove a subject from the list of subjects.void
setCoverage
(String coverage) Set the coverage property.void
setDescription
(String description) Set the default value for the description.void
setDescription
(String language, String description) Set the description of this resource in a specific language.void
Set the format property.void
setIdentifier
(String id) Set the resource identifier.void
Set the default value for the rights of this document.void
Set the rights for this resource in a specific language.void
Set the resource source identifier.void
Set the default value for the title.void
Set the title of this resource in a specific language.Methods inherited from class org.apache.jempbox.xmp.XMPSchema
addBagValue, addSequenceDateValue, addSequenceValue, addSequenceValue, getAbout, getBagList, getBooleanProperty, getDateProperty, getElement, getEventSequenceList, getIntegerProperty, getLanguageProperty, getLanguagePropertyLanguages, getSequenceDateList, getSequenceList, getTextProperty, getThumbnailProperty, merge, removeBagValue, removeSequenceDateValue, removeSequenceValue, removeSequenceValue, setAbout, setBooleanProperty, setDateProperty, setIntegerProperty, setLanguageProperty, setTextProperty, setThumbnailProperty
-
Field Details
-
NAMESPACE
The namespace for this schema.- See Also:
-
-
Constructor Details
-
XMPSchemaDublinCore
Construct a new blank Dublin Core schema.- Parameters:
parent
- The parent metadata schema that this will be part of.
-
XMPSchemaDublinCore
Constructor from existing XML element.- Parameters:
element
- The existing element.prefix
- The schema prefix.
-
-
Method Details
-
removeContributor
Remove a contributor from the list of contributors.- Parameters:
contributor
- The contributor to remove.
-
addContributor
Add a contributor to the list of contributors. A contributor is someone other than an author.- Parameters:
contributor
- The name of the contributor.
-
getContributors
Get the complete list of contributors.- Returns:
- The list of contributors.
-
setCoverage
Set the coverage property.- Parameters:
coverage
- The extend or scope of the resource.
-
getCoverage
Get the coverage property.- Returns:
- The extent or scope of the resource.
-
removeCreator
Remove a creator from the list of creators.- Parameters:
creator
- The author of the resource.
-
addCreator
Add a creator.- Parameters:
creator
- The author of the resource.
-
getCreators
Get a complete list of creators.- Returns:
- A list of java.lang.String objects.
-
removeDate
Remove a date from the list of 'interesting' dates.- Parameters:
date
- The date to remove.
-
addDate
Add a date of interest to this schema.- Parameters:
date
- The date to add to the schema.
-
getDates
Get a list of all dates of interest to this resource.- Returns:
- A list of java.util.Calendar objects.
- Throws:
IOException
- If there is an error creating the date object.
-
setDescription
Set the default value for the description.- Parameters:
description
- The description of this resource.
-
getDescription
Get the default value for the description.- Returns:
- The description of this resource.
-
setDescription
Set the description of this resource in a specific language.- Parameters:
language
- The language code.description
- The description in a specific language.
-
getDescription
Get the description in a specific language.- Parameters:
language
- The language code to get the description for.- Returns:
- The description in the specified language or null if it does not exist.
-
getDescriptionLanguages
Get a list of all languages that a description exists for.- Returns:
- A non-null list of languages, potentially an empty list.
-
setFormat
Set the format property.- Parameters:
format
- The mime-type of the saved resource.
-
getFormat
Get the format property.- Returns:
- The mime-type of the resource.
-
setIdentifier
Set the resource identifier.- Parameters:
id
- An id to the resource.
-
getIdentifier
Get the resource id.- Returns:
- A key that identifies this resource.
-
removeLanguage
Remove a language from the list of languages.- Parameters:
language
- The language to remove.
-
addLanguage
Add a language to the list of languages.- Parameters:
language
- The name of the language.
-
getLanguages
Get the complete list of languages.- Returns:
- The list of languages.
-
removePublisher
Remove a publisher from the list of publishers.- Parameters:
publisher
- The publisher to remove.
-
addPublisher
Add a publisher to the list of publishers.- Parameters:
publisher
- The name of the publisher.
-
getPublishers
Get the complete list of publishers.- Returns:
- The list of publishers.
-
removeRelation
Remove a relation from the list of relationships. A relationship to another resource.- Parameters:
relation
- The publisher to remove.
-
addRelation
Add a relation to the list of relationships. A relationship to another resource.- Parameters:
relation
- The relation to the other resource.
-
getRelationships
Get the complete list of relationships.- Returns:
- The list of relationships.
-
setRights
Set the default value for the rights of this document. This property specifies informal rights of the document.- Parameters:
rights
- The rights for this resource.
-
getRights
Get the default value for the rights of this document.- Returns:
- The informal rights for this resource.
-
setRights
Set the rights for this resource in a specific language.- Parameters:
language
- The language code.rights
- The rights in a specific language.
-
getRights
Get the rights in a specific language.- Parameters:
language
- The language code to get the description for.- Returns:
- The rights in the specified language or null if it does not exist.
-
getRightsLanguages
Get a list of all languages that a rights description exists for.- Returns:
- A non-null list of languages, potentially an empty list.
-
setSource
Set the resource source identifier.- Parameters:
id
- An id to the resource source.
-
getSource
Get the resource source id.- Returns:
- A key that identifies this source of this resource.
-
removeSubject
Remove a subject from the list of subjects.- Parameters:
subject
- The subject to remove.
-
addSubject
Add a subject to the list of subjects.- Parameters:
subject
- The subject of this resource.
-
getSubjects
Get the complete list of subjects.- Returns:
- The list of subjects.
-
setTitle
Set the default value for the title.- Parameters:
title
- The title of this resource.
-
getTitle
Get the default value for the title.- Returns:
- The title of this resource.
-
setTitle
Set the title of this resource in a specific language.- Parameters:
language
- The language code.title
- The title in a specific language.
-
getTitle
Get the title in a specific language.- Parameters:
language
- The language code to get the description for.- Returns:
- The title in the specified language or null if it does not exist.
-
getTitleLanguages
Get a list of all languages that a title exists for.- Returns:
- A non-null list of languages, potentially an empty list.
-
addType
Add a type to the bag of types of this resource.- Parameters:
type
- The type of resource to add (poem, novel).
-
getTypes
Get the list of types for this resource.- Returns:
- A list of types for this resource.
-