de.gerdiproject.json.datacite

Class Rights

java.lang.Object

de.gerdiproject.json.datacite.Rights

All Implemented Interfaces:

ICleanable

public class Rights
extends Object
implements ICleanable

Any rights information for this resource. Provide a rights management statement for the resource or reference a service providing such information. Include embargo information if applicable. Use the complete title of a license and include version information if applicable. 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
Rights(@NonNull String value)
Rights(String value, String lang) Constructor that allows to set the language.
Rights(@NonNull String value, String lang, String uri, String identifier, String identifierScheme, String schemeURI)

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	getIdentifier() Retrieves the short, standardized version of the license name.
String	getIdentifierScheme() Retrieves the name of the scheme.
String	getLang() Retrieves the IETF language tag of the text.
String	getSchemeURI() Retrieves the URI of the rightsIdentifierScheme.
String	getUri() Retrieves the URI of the license.
@NonNull String	getValue() Retrieves the free text that describes the rights.
int	hashCode()
void	setIdentifier(String identifier) Sets the short, standardized version of the license name.
void	setIdentifierScheme(String identifierScheme) Sets the name of the scheme.
void	setLang(String lang) Sets the IETF language tag of the text.
void	setSchemeURI(String schemeURI) Sets the URI of the rightsIdentifierScheme.
void	setUri(String uri) Sets the URI of the license.
void	setValue(@NonNull String value) Sets the free text that describes the rights.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Rights

public Rights(String value,
              String lang)

Constructor that allows to set the language.

Parameters:

value - free text that describes the rights

lang - a IETF language tag of the text

Rights

public Rights(@NonNull
              @NonNull String value)

Rights

public Rights(@NonNull
              @NonNull String value,
              String lang,
              String uri,
              String identifier,
              String identifierScheme,
              String schemeURI)

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 free text that describes the rights.
e.g. Creative Commons, Attribution 3.0 Germany

Returns:

free text that describes the rights

getLang

public String getLang()

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

Returns:

the IETF language tag of the text

getUri

public String getUri()

Retrieves the URI of the license.
e.g. http://creativecommons.org/licenses/by/3.0/de/deed.en

Returns:

the URI of the license.

getIdentifier

public String getIdentifier()

Retrieves the short, standardized version of the license name.
e.g. CC-BY-3.0

It’s suggested to use the identifiers from the SPDX licence list (https://spdx.org/licenses/).

Returns:

a short, standardized version of the license name

getIdentifierScheme

public String getIdentifierScheme()

Retrieves the name of the scheme.
e.g. SPDX

Returns:

the name of the scheme

getSchemeURI

public String getSchemeURI()

Retrieves the URI of the rightsIdentifierScheme.
e.g. https://spdx.org/licenses/

Returns:

the URI of the rightsIdentifierScheme

setValue

public void setValue(@NonNull
                     @NonNull String value)

Sets the free text that describes the rights.
e.g. Creative Commons, Attribution 3.0 Germany

Parameters:

value - free text that describes the rights

setLang

public void setLang(String lang)

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

Parameters:

lang - the IETF language tag of the text

setUri

public void setUri(String uri)

Sets the URI of the license.
e.g. http://creativecommons.org/licenses/by/3.0/de/deed.en

Parameters:

uri - the URI of the license.

setIdentifier

public void setIdentifier(String identifier)

Sets the short, standardized version of the license name.
e.g. CC-BY-3.0

It’s suggested to use the identifiers from the SPDX licence list (https://spdx.org/licenses/).

Parameters:

identifier - short, standardized version of the license name

setIdentifierScheme

public void setIdentifierScheme(String identifierScheme)

Sets the name of the scheme.
e.g. SPDX

Parameters:

identifierScheme - the name of the scheme

setSchemeURI

public void setSchemeURI(String schemeURI)

Sets the URI of the rightsIdentifierScheme.
e.g. https://spdx.org/licenses/

Parameters:

schemeURI - the URI of the rightsIdentifierScheme

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