org.apache.lenya.cms.publication
Interface DublinCore

All Known Implementing Classes:

DublinCoreProxy

public interface DublinCore

Field Summary

static java.lang.String	ELEMENT_CONTRIBUTOR
static java.lang.String	ELEMENT_COVERAGE
static java.lang.String	ELEMENT_CREATOR
static java.lang.String	ELEMENT_DATE
static java.lang.String	ELEMENT_DESCRIPTION
static java.lang.String	ELEMENT_FORMAT
static java.lang.String	ELEMENT_IDENTIFIER
static java.lang.String	ELEMENT_LANGUAGE
static java.lang.String	ELEMENT_PUBLISHER
static java.lang.String	ELEMENT_RELATION
static java.lang.String	ELEMENT_RIGHTS
static java.lang.String	ELEMENT_SOURCE
static java.lang.String	ELEMENT_SUBJECT
static java.lang.String	ELEMENT_TITLE
static java.lang.String	ELEMENT_TYPE
static java.lang.String	TERM_ABSTRACT
static java.lang.String	TERM_ACCESSRIGHTS
static java.lang.String	TERM_ALTERNATIVE
static java.lang.String	TERM_AUDIENCE
static java.lang.String	TERM_AVAILABLE
static java.lang.String	TERM_BIBLIOGRAPHICCITATION
static java.lang.String	TERM_CONFORMSTO
static java.lang.String	TERM_CREATED
static java.lang.String	TERM_DATEACCEPTED
static java.lang.String	TERM_DATECOPYRIGHTED
static java.lang.String	TERM_DATESUBMITTED
static java.lang.String	TERM_EDUCATIONLEVEL
static java.lang.String	TERM_EXTENT
static java.lang.String	TERM_HASFORMAT
static java.lang.String	TERM_HASPART
static java.lang.String	TERM_HASVERSION
static java.lang.String	TERM_ISFORMATOF
static java.lang.String	TERM_ISPARTOF
static java.lang.String	TERM_ISREFERENCEDBY
static java.lang.String	TERM_ISREPLACEDBY
static java.lang.String	TERM_ISREQUIREDBY
static java.lang.String	TERM_ISSUED
static java.lang.String	TERM_ISVERSIONOF
static java.lang.String	TERM_MEDIATOR
static java.lang.String	TERM_MEDIUM
static java.lang.String	TERM_MODIFIED
static java.lang.String	TERM_REFERENCES
static java.lang.String	TERM_REPLACES
static java.lang.String	TERM_REQUIRES
static java.lang.String	TERM_SPATIAL
static java.lang.String	TERM_TABLEOFCONTENTS
static java.lang.String	TERM_TEMPORAL
static java.lang.String	TERM_VALID

Method Summary

void	addValue(java.lang.String key, java.lang.String value) Adds a value for a certain key.
void	addValues(java.lang.String key, java.lang.String[] values) Add all values for a certain key.
java.lang.String	getCreator() Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.
java.lang.String	getDateCreated() Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.
java.lang.String	getDateIssued() Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.
java.lang.String	getDescription() Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.
java.lang.String	getFirstValue(java.lang.String key) Returns the first value for a certain key.
java.lang.String	getIdentifier() Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.
java.lang.String	getIsReferencedBy() Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.
java.lang.String	getPublisher() Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.
java.lang.String	getRights() Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.
java.lang.String	getSubject() Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.
java.lang.String	getTitle() Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.
java.lang.String[]	getValues(java.lang.String key) Returns the values for a certain key.
void	removeAllValues(java.lang.String key) Removes all values for a certain key.
void	removeValue(java.lang.String key, java.lang.String value) Removes a specific value for a certain key.
void	replaceBy(DublinCore other) Replace the contents of the current dublin core by the contents of other.
void	save() Save the meta data.
void	setCreator(java.lang.String creator) Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.
void	setDateCreated(java.lang.String dateCreated) Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.
void	setDateIssued(java.lang.String dateIssued) Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.
void	setDescription(java.lang.String description) Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.
void	setIdentifier(java.lang.String identifier) Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.
void	setIsReferencedBy(java.lang.String isReferencedBy) Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.
void	setPublisher(java.lang.String publisher) Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.
void	setRights(java.lang.String rights) Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.
void	setSubject(java.lang.String subject) Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.
void	setTitle(java.lang.String title) Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.
void	setValue(java.lang.String key, java.lang.String value) Sets the value for a certain key.

Field Detail

ELEMENT_TITLE

static final java.lang.String ELEMENT_TITLE

See Also:

Constant Field Values

ELEMENT_CREATOR

static final java.lang.String ELEMENT_CREATOR

See Also:

Constant Field Values

ELEMENT_SUBJECT

static final java.lang.String ELEMENT_SUBJECT

See Also:

Constant Field Values

ELEMENT_DESCRIPTION

static final java.lang.String ELEMENT_DESCRIPTION

See Also:

Constant Field Values

ELEMENT_PUBLISHER

static final java.lang.String ELEMENT_PUBLISHER

See Also:

Constant Field Values

ELEMENT_CONTRIBUTOR

static final java.lang.String ELEMENT_CONTRIBUTOR

See Also:

Constant Field Values

ELEMENT_DATE

static final java.lang.String ELEMENT_DATE

See Also:

Constant Field Values

ELEMENT_TYPE

static final java.lang.String ELEMENT_TYPE

See Also:

Constant Field Values

ELEMENT_FORMAT

static final java.lang.String ELEMENT_FORMAT

See Also:

Constant Field Values

ELEMENT_IDENTIFIER

static final java.lang.String ELEMENT_IDENTIFIER

See Also:

Constant Field Values

ELEMENT_SOURCE

static final java.lang.String ELEMENT_SOURCE

See Also:

Constant Field Values

ELEMENT_LANGUAGE

static final java.lang.String ELEMENT_LANGUAGE

See Also:

Constant Field Values

ELEMENT_RELATION

static final java.lang.String ELEMENT_RELATION

See Also:

Constant Field Values

ELEMENT_COVERAGE

static final java.lang.String ELEMENT_COVERAGE

See Also:

Constant Field Values

ELEMENT_RIGHTS

static final java.lang.String ELEMENT_RIGHTS

See Also:

Constant Field Values

TERM_AUDIENCE

static final java.lang.String TERM_AUDIENCE

See Also:

Constant Field Values

TERM_ALTERNATIVE

static final java.lang.String TERM_ALTERNATIVE

See Also:

Constant Field Values

TERM_TABLEOFCONTENTS

static final java.lang.String TERM_TABLEOFCONTENTS

See Also:

Constant Field Values

TERM_ABSTRACT

static final java.lang.String TERM_ABSTRACT

See Also:

Constant Field Values

TERM_CREATED

static final java.lang.String TERM_CREATED

See Also:

Constant Field Values

TERM_VALID

static final java.lang.String TERM_VALID

See Also:

Constant Field Values

TERM_AVAILABLE

static final java.lang.String TERM_AVAILABLE

See Also:

Constant Field Values

TERM_ISSUED

static final java.lang.String TERM_ISSUED

See Also:

Constant Field Values

TERM_MODIFIED

static final java.lang.String TERM_MODIFIED

See Also:

Constant Field Values

TERM_EXTENT

static final java.lang.String TERM_EXTENT

See Also:

Constant Field Values

TERM_MEDIUM

static final java.lang.String TERM_MEDIUM

See Also:

Constant Field Values

TERM_ISVERSIONOF

static final java.lang.String TERM_ISVERSIONOF

See Also:

Constant Field Values

TERM_HASVERSION

static final java.lang.String TERM_HASVERSION

See Also:

Constant Field Values

TERM_ISREPLACEDBY

static final java.lang.String TERM_ISREPLACEDBY

See Also:

Constant Field Values

TERM_REPLACES

static final java.lang.String TERM_REPLACES

See Also:

Constant Field Values

TERM_ISREQUIREDBY

static final java.lang.String TERM_ISREQUIREDBY

See Also:

Constant Field Values

TERM_REQUIRES

static final java.lang.String TERM_REQUIRES

See Also:

Constant Field Values

TERM_ISPARTOF

static final java.lang.String TERM_ISPARTOF

See Also:

Constant Field Values

TERM_HASPART

static final java.lang.String TERM_HASPART

See Also:

Constant Field Values

TERM_ISREFERENCEDBY

static final java.lang.String TERM_ISREFERENCEDBY

See Also:

Constant Field Values

TERM_REFERENCES

static final java.lang.String TERM_REFERENCES

See Also:

Constant Field Values

TERM_ISFORMATOF

static final java.lang.String TERM_ISFORMATOF

See Also:

Constant Field Values

TERM_HASFORMAT

static final java.lang.String TERM_HASFORMAT

See Also:

Constant Field Values

TERM_CONFORMSTO

static final java.lang.String TERM_CONFORMSTO

See Also:

Constant Field Values

TERM_SPATIAL

static final java.lang.String TERM_SPATIAL

See Also:

Constant Field Values

TERM_TEMPORAL

static final java.lang.String TERM_TEMPORAL

See Also:

Constant Field Values

TERM_MEDIATOR

static final java.lang.String TERM_MEDIATOR

See Also:

Constant Field Values

TERM_DATEACCEPTED

static final java.lang.String TERM_DATEACCEPTED

See Also:

Constant Field Values

TERM_DATECOPYRIGHTED

static final java.lang.String TERM_DATECOPYRIGHTED

See Also:

Constant Field Values

TERM_DATESUBMITTED

static final java.lang.String TERM_DATESUBMITTED

See Also:

Constant Field Values

TERM_EDUCATIONLEVEL

static final java.lang.String TERM_EDUCATIONLEVEL

See Also:

Constant Field Values

TERM_ACCESSRIGHTS

static final java.lang.String TERM_ACCESSRIGHTS

See Also:

Constant Field Values

TERM_BIBLIOGRAPHICCITATION

static final java.lang.String TERM_BIBLIOGRAPHICCITATION

See Also:

Constant Field Values

Method Detail

save

void save()
          throws DocumentException

Save the meta data.

Throws:

DocumentException - if the meta data could not be made persistent.

getCreator

java.lang.String getCreator()
                            throws DocumentException

Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.

Get the creator

Returns:

the creator

Throws:

DocumentException - if an error occurs

setCreator

void setCreator(java.lang.String creator)
                throws DocumentException

Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.

Set the DC creator

Parameters:

creator - the Creator

Throws:

DocumentException - if an error occurs

getTitle

java.lang.String getTitle()
                          throws DocumentException

Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.

Get the title

Returns:

the title

Throws:

DocumentException - if an error occurs

setTitle

void setTitle(java.lang.String title)
              throws DocumentException

Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.

Set the DC title

Parameters:

title - the title

Throws:

DocumentException - if an error occurs

getDescription

java.lang.String getDescription()
                                throws DocumentException

Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.

Get the description

Returns:

the description

Throws:

DocumentException - if an error occurs

setDescription

void setDescription(java.lang.String description)
                    throws DocumentException

Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.

Set the DC Description

Parameters:

description - the description

Throws:

DocumentException - if an error occurs

getIdentifier

java.lang.String getIdentifier()
                               throws DocumentException

Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.

Get the identifier

Returns:

the identifier

Throws:

DocumentException - if an error occurs

setIdentifier

void setIdentifier(java.lang.String identifier)
                   throws DocumentException

Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.

Set the DC Identifier

Parameters:

identifier - the identifier

Throws:

DocumentException - if an error occurs

getSubject

java.lang.String getSubject()
                            throws DocumentException

Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.

Get the subject.

Returns:

the subject

Throws:

DocumentException - if an error occurs

setSubject

void setSubject(java.lang.String subject)
                throws DocumentException

Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.

Set the DC Subject

Parameters:

subject - the subject

Throws:

DocumentException - if an error occurs

getPublisher

java.lang.String getPublisher()
                              throws DocumentException

Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.

Get the publisher

Returns:

the publisher

Throws:

DocumentException - if an error occurs

setPublisher

void setPublisher(java.lang.String publisher)
                  throws DocumentException

Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.

Set the publisher

Parameters:

publisher - the publisher

Throws:

DocumentException - if an error occurs

getDateIssued

java.lang.String getDateIssued()
                               throws DocumentException

Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.

Get the date of issue

Returns:

the date of issue

Throws:

DocumentException - if an error occurs

setDateIssued

void setDateIssued(java.lang.String dateIssued)
                   throws DocumentException

Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.

Set the date of issue

Parameters:

dateIssued - the date of issue

Throws:

DocumentException - if an error occurs

getDateCreated

java.lang.String getDateCreated()
                                throws DocumentException

Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.

Get the date of creation

Returns:

the date of creation

Throws:

DocumentException - if an error occurs

setDateCreated

void setDateCreated(java.lang.String dateCreated)
                    throws DocumentException

Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.

Set the date of creation

Parameters:

dateCreated - the date of creation

Throws:

DocumentException - if an error occurs

getRights

java.lang.String getRights()
                           throws DocumentException

Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.

Get the rights

Returns:

the rights

Throws:

DocumentException - if an error occurs

setRights

void setRights(java.lang.String rights)
               throws DocumentException

Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.

Set the DC Rights

Parameters:

rights - the rights

Throws:

DocumentException - if an error occurs

getIsReferencedBy

java.lang.String getIsReferencedBy()
                                   throws DocumentException

Deprecated. Use getValues(java.lang.String) or getFirstValue(java.lang.String) instead.

Get isReferencedBy

Returns:

isReferencedBy

Throws:

DocumentException - if an error occurs

setIsReferencedBy

void setIsReferencedBy(java.lang.String isReferencedBy)
                       throws DocumentException

Deprecated. Use addValue(java.lang.String, java.lang.String) or setValue(java.lang.String, java.lang.String) instead.

Set isReferencedBy

Parameters:

isReferencedBy - isReferencedBy

Throws:

DocumentException - if an error occurs

getValues

java.lang.String[] getValues(java.lang.String key)
                             throws DocumentException

Returns the values for a certain key.

Parameters:

key - The key.

Returns:

An array of strings.

Throws:

DocumentException - when something went wrong.

getFirstValue

java.lang.String getFirstValue(java.lang.String key)
                               throws DocumentException

Returns the first value for a certain key.

Parameters:

key - The key.

Returns:

A string or null if no value is set for this key.

Throws:

DocumentException - if an error occurs.

setValue

void setValue(java.lang.String key,
              java.lang.String value)
              throws DocumentException

Sets the value for a certain key. All existing values will be removed.

Parameters:

key - The key.

value - The value to set.

Throws:

DocumentException - when something went wrong.

addValue

void addValue(java.lang.String key,
              java.lang.String value)
              throws DocumentException

Adds a value for a certain key.

Parameters:

key - The key.

value - The value to add.

Throws:

DocumentException - when something went wrong.

addValues

void addValues(java.lang.String key,
               java.lang.String[] values)
               throws DocumentException

Add all values for a certain key.

Parameters:

key - The key

values - The value to add

Throws:

DocumentException - if something went wrong

removeValue

void removeValue(java.lang.String key,
                 java.lang.String value)
                 throws DocumentException

Removes a specific value for a certain key.

Parameters:

key - The key.

value - The value to remove.

Throws:

DocumentException - when something went wrong.

removeAllValues

void removeAllValues(java.lang.String key)
                     throws DocumentException

Removes all values for a certain key.

Parameters:

key - The key.

Throws:

DocumentException - when something went wrong.

replaceBy

void replaceBy(DublinCore other)
               throws DocumentException

Replace the contents of the current dublin core by the contents of other.

Parameters:

other - The other dublin core object.

Throws:

DocumentException - if an error occurs.