Package org.ivoa.dm.tool

Class Author

java.lang.Object

org.ivoa.dm.tool.Author

All Implemented Interfaces:

org.ivoa.vodml.jaxb.XmlIdManagement, org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

@Entity
@VoDml(id="tool:Author",
       role=objectType)
public class Author
extends Object
implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>, org.ivoa.vodml.jaxb.XmlIdManagement

Details about an author of the image. objectType: Author

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Author.AuthorBuilder	A builder class for Author, mainly for use in the functional builder pattern.

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	_id	inserted database key
protected String	affiliation	Affiliation .
protected String	email	Contact email address for the author.
protected String	github	GitHub username .
protected String	gitlab	GitLab username .
protected String	name	Name of the author.
protected String	orcid	ORCID identity.
protected String	role	Role of the author; default maintainer.

Constructor Summary

Constructors

Constructor	Description
Author()	Creates a new Author
Author(String name, String email, String role, String github, String gitlab, String orcid, String affiliation)	full parameter constructor.
Author(Author other)	Copy Constructor.

Method Summary

Modifier and Type	Method	Description
static Author	createAuthor(Consumer<Author.AuthorBuilder> f)	create a Author in functional builder style.
void	delete(jakarta.persistence.EntityManager em)
void	forceLoad()
String	getAffiliation()	Returns affiliation Attribute.
String	getEmail()	Returns email Attribute.
String	getGithub()	Returns github Attribute.
String	getGitlab()	Returns gitlab Attribute.
Long	getId()
String	getName()	Returns name Attribute.
String	getOrcid()	Returns orcid Attribute.
String	getRole()	Returns role Attribute.
String	getXmlId()	getter for XMLID
boolean	hasNaturalKey()
void	setAffiliation(String pAffiliation)	Set affiliation Attribute.
void	setEmail(String pEmail)	Set email Attribute.
void	setGithub(String pGithub)	Set github Attribute.
void	setGitlab(String pGitlab)	Set gitlab Attribute.
void	setName(String pName)	Set name Attribute.
void	setOrcid(String pOrcid)	Set orcid Attribute.
void	setRole(String pRole)	Set role Attribute.
void	setXmlId(String id)
void	updateUsing(Author other)	Update this object with the content of the given object.
Author	withAffiliation(String pAffiliation)	fluent setter for affiliation Attribute.
Author	withEmail(String pEmail)	fluent setter for email Attribute.
Author	withGithub(String pGithub)	fluent setter for github Attribute.
Author	withGitlab(String pGitlab)	fluent setter for gitlab Attribute.
Author	withName(String pName)	fluent setter for name Attribute.
Author	withOrcid(String pOrcid)	fluent setter for orcid Attribute.
Author	withRole(String pRole)	fluent setter for role Attribute.

Methods inherited from class java.lang.Object

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

Field Details

_id

protected Long _id

inserted database key

name

@VoDml(id="tool:Author.name",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String name

Name of the author. : Attribute name type ivoa:string : multiplicity 1

email

@VoDml(id="tool:Author.email",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String email

Contact email address for the author. : Attribute email type ivoa:string : multiplicity 1

role

@VoDml(id="tool:Author.role",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String role

Role of the author; default maintainer. : Attribute role type ivoa:string : multiplicity 0..1

github

@VoDml(id="tool:Author.github",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String github

GitHub username . : Attribute github type ivoa:string : multiplicity 0..1

gitlab

@VoDml(id="tool:Author.gitlab",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String gitlab

GitLab username . : Attribute gitlab type ivoa:string : multiplicity 0..1

orcid

@VoDml(id="tool:Author.orcid",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String orcid

ORCID identity. : Attribute orcid type ivoa:string : multiplicity 0..1

affiliation

@VoDml(id="tool:Author.affiliation",
       role=attribute,
       type="ivoa:string",
       typeRole=primitiveType)
protected String affiliation

Affiliation . : Attribute affiliation type ivoa:string : multiplicity 0..1

Constructor Details

Author

public Author()

Creates a new Author

Author

public Author(String name,
 String email,
 String role,
 String github,
 String gitlab,
 String orcid,
 String affiliation)

full parameter constructor.

Parameters:

name - Name of the author.

email - Contact email address for the author.

role - Role of the author; default maintainer.

github - GitHub username .

gitlab - GitLab username .

orcid - ORCID identity.

affiliation - Affiliation .

Author

public Author(Author other)

Copy Constructor. Note that references will remain as is rather than be copied.

Parameters:

other - the object to be copied.

Method Details

getId

public Long getId()

Specified by:

getId in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>

Returns:

the id

getXmlId

public String getXmlId()

getter for XMLID

Specified by:

getXmlId in interface org.ivoa.vodml.jaxb.XmlIdManagement

setXmlId

public void setXmlId(String id)

Specified by:

setXmlId in interface org.ivoa.vodml.jaxb.XmlIdManagement

hasNaturalKey

public boolean hasNaturalKey()

Specified by:

hasNaturalKey in interface org.ivoa.vodml.jaxb.XmlIdManagement

updateUsing

public void updateUsing(Author other)

Update this object with the content of the given object. Note that references will remain as is rather than be copied.

Parameters:

other - the object to be copied.

getName

public String getName()

Returns name Attribute.

Returns:

name Attribute

setName

public void setName(String pName)

Set name Attribute.

Parameters:

pName - value to set

withName

public Author withName(String pName)

fluent setter for name Attribute.

Parameters:

pName - value to set

Returns:

Author

getEmail

public String getEmail()

Returns email Attribute.

Returns:

email Attribute

setEmail

public void setEmail(String pEmail)

Set email Attribute.

Parameters:

pEmail - value to set

withEmail

public Author withEmail(String pEmail)

fluent setter for email Attribute.

Parameters:

pEmail - value to set

Returns:

Author

getRole

public String getRole()

Returns role Attribute.

Returns:

role Attribute

setRole

public void setRole(String pRole)

Set role Attribute.

Parameters:

pRole - value to set

withRole

public Author withRole(String pRole)

fluent setter for role Attribute.

Parameters:

pRole - value to set

Returns:

Author

getGithub

public String getGithub()

Returns github Attribute.

Returns:

github Attribute

setGithub

public void setGithub(String pGithub)

Set github Attribute.

Parameters:

pGithub - value to set

withGithub

public Author withGithub(String pGithub)

fluent setter for github Attribute.

Parameters:

pGithub - value to set

Returns:

Author

getGitlab

public String getGitlab()

Returns gitlab Attribute.

Returns:

gitlab Attribute

setGitlab

public void setGitlab(String pGitlab)

Set gitlab Attribute.

Parameters:

pGitlab - value to set

withGitlab

public Author withGitlab(String pGitlab)

fluent setter for gitlab Attribute.

Parameters:

pGitlab - value to set

Returns:

Author

getOrcid

public String getOrcid()

Returns orcid Attribute.

Returns:

orcid Attribute

setOrcid

public void setOrcid(String pOrcid)

Set orcid Attribute.

Parameters:

pOrcid - value to set

withOrcid

public Author withOrcid(String pOrcid)

fluent setter for orcid Attribute.

Parameters:

pOrcid - value to set

Returns:

Author

getAffiliation

public String getAffiliation()

Returns affiliation Attribute.

Returns:

affiliation Attribute

setAffiliation

public void setAffiliation(String pAffiliation)

Set affiliation Attribute.

Parameters:

pAffiliation - value to set

withAffiliation

public Author withAffiliation(String pAffiliation)

fluent setter for affiliation Attribute.

Parameters:

pAffiliation - value to set

Returns:

Author

createAuthor

public static Author createAuthor(Consumer<Author.AuthorBuilder> f)

create a Author in functional builder style.

Parameters:

f - the functional builder.

Returns:

an object initialized from the builder.

forceLoad

public void forceLoad()

Specified by:

forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations

delete

public void delete(jakarta.persistence.EntityManager em)

Specified by:

delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>