de.gerdiproject.json.datacite

Class Description

java.lang.Object

de.gerdiproject.json.datacite.Description

All Implemented Interfaces:

ICleanable

public class Description
extends Object
implements ICleanable

Additional information that does not fit in any of the other categories. May be used for technical information. NOTE: The DataCite schema allows br-tags here, which are not supported by Elastic Search and should be replaced with \n! 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
Description(String value, DescriptionType type) Constructor that requires all mandatory fields.
Description(String value, DescriptionType type, String language) Constructor that requires all fields.

Method Summary

Modifier and Type	Method and Description
void	clean() Cleans the description text, removing HTML and unescaping special characters.
String	getLang() Returns the language in which the description is written.
DescriptionType	getType() Returns the type of the description.
String	getValue() Returns a free text description.
void	setLang(String lang) Changes the language in which the description is written.
void	setType(DescriptionType type) Changes the type of the description.
void	setValue(String value) Changes a free text description.

Methods inherited from class java.lang.Object

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

Constructor Detail

Description

public Description(String value,
                   DescriptionType type)

Constructor that requires all mandatory fields.

Parameters:

value - free text description

type - the type of the free text

Description

public Description(String value,
                   DescriptionType type,
                   String language)

Constructor that requires all fields.

Parameters:

value - free text description

type - the type of the free text

language - IETF language tag

Method Detail

getValue

public String getValue()

Returns a free text description.

Returns:

a free text description

setValue

public void setValue(String value)

Changes a free text description. In XML, this is the value between the description-tags.

Parameters:

value - a free text description

getType

public DescriptionType getType()

Returns the type of the description. In XML, this is the value between the description-tags.

Returns:

what the description entails

setType

public void setType(DescriptionType type)

Changes the type of the description.

Parameters:

type - what the description entails

getLang

public String getLang()

Returns the language in which the description is written.

Returns:

the language in which the description is written

setLang

public void setLang(String lang)

Changes the language in which the description is written.
e.g. de, en-us

Parameters:

lang - the language in which the description is written

clean

public void clean()

Cleans the description text, removing HTML and unescaping special characters.

Specified by:

clean in interface ICleanable