de.gerdiproject.json.datacite

Class Subject

java.lang.Object

de.gerdiproject.json.datacite.Subject

All Implemented Interfaces:

ICleanable

public class Subject
extends Object
implements ICleanable

Subject, keywords (tags), classification codes, or key phrases describing the resource. Source: https://schema.datacite.org/meta/kernel-4.0/doc/DataCite-MetadataKernel_v4.0.pdf

Author:

Mathis Neumann, Robin Weiss

Constructor Summary

Constructors

Constructor and Description
Subject(@NonNull String value)
Subject(String value, String lang) Constructor that allows to set the language.
Subject(@NonNull String value, String lang, String scheme, String schemeURI, String valueURI)

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	clean() Cleans the object, making it compatible with the ElasticSearch index.
boolean	equals(Object o)
String	getLang() Retrieves the IETF language tag of the subject text.
String	getScheme() Retrieves the free text name of the subject scheme or classification code or authority if one is used.
String	getSchemeURI() Retrieves the URI of the subject identifier scheme.
@NonNull String	getValue() Retrieves the term that describes the resource.
String	getValueURI() Retrieves the URI of the subject term.
int	hashCode()
void	setLang(String lang) Sets the IETF language tag of the subject text.
void	setScheme(String scheme) Sets the free text name of the subject scheme or classification code or authority if one is used.
void	setSchemeURI(String schemeURI) Sets the URI of the subject identifier scheme.
void	setValue(@NonNull String value) Sets the term that describes the resource.
void	setValueURI(String valueURI) Sets the URI of the subject term.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Subject

public Subject(String value,
               String lang)

Constructor that allows to set the language.

Parameters:

value - a term that describes the resource

lang - a IETF language tag of the subject text

Subject

public Subject(@NonNull
               @NonNull String value)

Subject

public Subject(@NonNull
               @NonNull String value,
               String lang,
               String scheme,
               String schemeURI,
               String valueURI)

Method Detail

clean

public boolean clean()

Description copied from interface: ICleanable

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

Specified by:

clean in interface ICleanable

Returns:

true if the clean up was successful and the object is now valid

getValue

@NonNull
public @NonNull String getValue()

Retrieves the term that describes the resource.
e.g. Fishery, Dates

Returns:

a term that describes the resource

getLang

public String getLang()

Retrieves the IETF language tag of the subject text.
e.g. de, en-US

Returns:

the IETF language tag of the subject text

getScheme

public String getScheme()

Retrieves the free text name of the subject scheme or classification code or authority if one is used.

Returns:

the free text name of the subject scheme

getSchemeURI

public String getSchemeURI()

Retrieves the URI of the subject identifier scheme.
e.g. http://id.loc.gov/authorities/subjects

Returns:

the URI of the subject identifier scheme

getValueURI

public String getValueURI()

Retrieves the URI of the subject term.
e.g. http://id.loc.gov/authorities/subjects/sh85026196

Returns:

the URI of the subject term

setValue

public void setValue(@NonNull
                     @NonNull String value)

Sets the term that describes the resource.
e.g. Fishery, Dates

Parameters:

value - a term that describes the resource

setLang

public void setLang(String lang)

Sets the IETF language tag of the subject text.
e.g. de, en-US

Parameters:

lang - the IETF language tag of the subject text

setScheme

public void setScheme(String scheme)

Sets the free text name of the subject scheme or classification code or authority if one is used.

Parameters:

scheme - the free text name of the subject scheme

setSchemeURI

public void setSchemeURI(String schemeURI)

Sets the URI of the subject identifier scheme.
e.g. http://id.loc.gov/authorities/subjects

Parameters:

schemeURI - the URI of the subject identifier scheme

setValueURI

public void setValueURI(String valueURI)

Sets the URI of the subject term.
e.g. http://id.loc.gov/authorities/subjects/sh85026196

Parameters:

valueURI - the URI of the subject term

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object