org.hkijena.jipipe.api

Class JIPipeAuthorMetadata

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.JIPipeAuthorMetadata

All Implemented Interfaces:

JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener

public class JIPipeAuthorMetadata
extends AbstractJIPipeParameterCollection

Models an author with affiliations

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeAuthorMetadata.List

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Constructor Summary

Constructors

Constructor and Description
JIPipeAuthorMetadata() Creates a new instance
JIPipeAuthorMetadata(JIPipeAuthorMetadata other)
JIPipeAuthorMetadata(String title, String firstName, String lastName, StringList affiliations, String website, String contact, boolean firstAuthor, boolean correspondingAuthor) Initializes the instance
JIPipeAuthorMetadata(String title, String firstName, String lastName, StringList affiliations, String website, String contact, String orcid, boolean firstAuthor, boolean correspondingAuthor) Initializes the instance

Method Summary

Modifier and Type	Method and Description
boolean	fuzzyEquals(JIPipeAuthorMetadata other) A fuzzy equals method that attempts to check if the authors are the same
StringList	getAffiliations()
String	getContact()
HTMLText	getCustomText()
String	getFirstName()
String	getLastName()
String	getOrcid()
String	getOrcidUrl()
String	getTitle()
String	getWebsite()
boolean	isCorrespondingAuthor()
boolean	isFirstAuthor()
void	mergeWith(JIPipeAuthorMetadata other)
static JFrame	openAuthorInfoWindow(Component parent, Collection<JIPipeAuthorMetadata> authors, JIPipeAuthorMetadata targetAuthor) Opens a list of authors in a window that displays information about them.
void	setAffiliations(StringList affiliations)
void	setContact(String contact)
void	setCorrespondingAuthor(boolean correspondingAuthor)
void	setCustomText(HTMLText customText)
void	setFirstAuthor(boolean firstAuthor)
void	setFirstName(String firstName)
void	setLastName(String lastName)
void	setOrcid(String orcid)
void	setTitle(String title)
void	setWebsite(String website)
String	toString()

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, registerSubParameter, registerSubParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Constructor Detail

JIPipeAuthorMetadata

public JIPipeAuthorMetadata()

Creates a new instance

JIPipeAuthorMetadata

public JIPipeAuthorMetadata(String title,
                            String firstName,
                            String lastName,
                            StringList affiliations,
                            String website,
                            String contact,
                            String orcid,
                            boolean firstAuthor,
                            boolean correspondingAuthor)

Initializes the instance

Parameters:

title - the title (can be empty)

firstName - first name

lastName - last name

affiliations - list of affiliations

website - optional website link

contact - contact information, e.g., an E-Mail address

firstAuthor - if the author is marked as first author

correspondingAuthor - if the author is marked as corresponding author

JIPipeAuthorMetadata

public JIPipeAuthorMetadata(String title,
                            String firstName,
                            String lastName,
                            StringList affiliations,
                            String website,
                            String contact,
                            boolean firstAuthor,
                            boolean correspondingAuthor)

Initializes the instance

Parameters:

title - the title (can be empty)

firstName - first name

lastName - last name

affiliations - list of affiliations

website - optional website link

contact - contact information, e.g., an E-Mail address

firstAuthor - if the author is marked as first author

correspondingAuthor - if the author is marked as corresponding author

JIPipeAuthorMetadata

public JIPipeAuthorMetadata(JIPipeAuthorMetadata other)

Method Detail

openAuthorInfoWindow

public static JFrame openAuthorInfoWindow(Component parent,
                                          Collection<JIPipeAuthorMetadata> authors,
                                          JIPipeAuthorMetadata targetAuthor)

Opens a list of authors in a window that displays information about them.

Parameters:

parent - the parent component

authors - the list of authors

targetAuthor - the author to show first. Can be null.

Returns:

the window

getOrcidUrl

public String getOrcidUrl()

fuzzyEquals

public boolean fuzzyEquals(JIPipeAuthorMetadata other)

A fuzzy equals method that attempts to check if the authors are the same

Parameters:

other - the other author

Returns:

if they are likely the same

getOrcid

public String getOrcid()

setOrcid

public void setOrcid(String orcid)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getFirstName

public String getFirstName()

setFirstName

public void setFirstName(String firstName)

getLastName

public String getLastName()

setLastName

public void setLastName(String lastName)

getAffiliations

public StringList getAffiliations()

setAffiliations

public void setAffiliations(StringList affiliations)

getContact

public String getContact()

setContact

public void setContact(String contact)

getWebsite

public String getWebsite()

setWebsite

public void setWebsite(String website)

isFirstAuthor

public boolean isFirstAuthor()

setFirstAuthor

public void setFirstAuthor(boolean firstAuthor)

isCorrespondingAuthor

public boolean isCorrespondingAuthor()

setCorrespondingAuthor

public void setCorrespondingAuthor(boolean correspondingAuthor)

getCustomText

public HTMLText getCustomText()

setCustomText

public void setCustomText(HTMLText customText)

toString

public String toString()

Overrides:

toString in class Object

mergeWith

public void mergeWith(JIPipeAuthorMetadata other)