de.gerdiproject.json.datacite

Class Title

java.lang.Object

de.gerdiproject.json.datacite.Title

All Implemented Interfaces:

ICleanable

public class Title
extends Object
implements ICleanable

A name or title by which a resource is known. Source: https://schema.datacite.org/meta/kernel-4.1/doc/DataCite-MetadataKernel_v4.1.pdf

Author:

Mathis Neumann, Robin Weiss

Constructor Summary

Constructors

Constructor and Description
Title(String value) Simple constructor that requires all mandatory fields.

Method Summary

Modifier and Type	Method and Description
void	clean() Cleans the object, making it compatible with the ElasticSearch index.
String	getLang() Returns the language of the title text.
TitleType	getType() Returns the type of title, or null if this is the main title.
String	getValue() Returns a free text title or name.
void	setLang(String lang) Changes the language of the title text.
void	setType(TitleType type) Changes the type of title.
void	setValue(String value) Changes the free text title or name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Title

public Title(String value)

Simple constructor that requires all mandatory fields.

Parameters:

value - the title text

Method Detail

getValue

public String getValue()

Returns a free text title or name. In XML, this is the value between the title-tags.

Returns:

a free text title or name

setValue

public void setValue(String value)

Changes the free text title or name. In XML, this is the value between the title-tags.
e.g. Crops, Catch Value in the Atlantic Ocean

Parameters:

value - a free text title or name

getType

public TitleType getType()

Returns the type of title, or null if this is the main title.

Returns:

the type of title

setType

public void setType(TitleType type)

Changes the type of title. May be 'null' to represent the main title of the document.

Parameters:

type - the type of title

getLang

public String getLang()

Returns the language of the title text.

Returns:

the language of the title text

setLang

public void setLang(String lang)

Changes the language of the title text.
e.g. de, en-US

Parameters:

lang - the language of the title text

clean

public void clean()

Description copied from interface: ICleanable

Cleans the object, making it compatible with the ElasticSearch index.

Specified by:

clean in interface ICleanable