au.ands.org.researchdata

Class RDACollectionDescriptor

java.lang.Object

au.ands.org.researchdata.RDACollectionDescriptor

public class RDACollectionDescriptor
extends java.lang.Object

Description of a collection for Research Data Australia.

Constructor Summary

Constructors

Constructor and Description
RDACollectionDescriptor() Default constructor.
RDACollectionDescriptor(int[] spectrumIdsArray) Constructor using an array of spectrum identifiers.
RDACollectionDescriptor(java.util.List<java.lang.Integer> spectrumIdsList) Constructor using a list of spectrum identifiers.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBriefDescription() Get the brief description of the collection.
java.lang.String	getPrimaryName() Get the primary name of the collection.
User	getPrincipalInvestigator() Get the principal investigator of the collection.
int[]	getSpectrumIds() Get the spectrum identifiers in the collection.
void	setBriefDescription(java.lang.String briefDescriptionIn) Set the brief description of the collection.
void	setPrimaryName(java.lang.String primaryNameIn) Set the primary name of the collection.
void	setPrincipalInvestigator(User principalInvestigatorIn) Set the principal investigator of the collection.
void	setSpectrumIds(int[] spectrumIdsIn) Set the spectrum identifiers in the collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

RDACollectionDescriptor

public RDACollectionDescriptor()

Default constructor.

RDACollectionDescriptor

public RDACollectionDescriptor(int[] spectrumIdsArray)

Constructor using an array of spectrum identifiers.

Parameters:

spectrumIdsArray - the identifiers of the spectra in the collection

RDACollectionDescriptor

public RDACollectionDescriptor(java.util.List<java.lang.Integer> spectrumIdsList)

Constructor using a list of spectrum identifiers.

Parameters:

spectrumIdsList - the list of identifiers

Method Detail

getBriefDescription

public java.lang.String getBriefDescription()

Get the brief description of the collection.

Returns:

the brief description of the collection

setBriefDescription

public void setBriefDescription(java.lang.String briefDescriptionIn)

Set the brief description of the collection.

Parameters:

briefDescriptionIn - a brief description

getPrimaryName

public java.lang.String getPrimaryName()

Get the primary name of the collection.

Returns:

the primary name of the collection

setPrimaryName

public void setPrimaryName(java.lang.String primaryNameIn)

Set the primary name of the collection.

Parameters:

primaryNameIn - the primary name

getPrincipalInvestigator

public User getPrincipalInvestigator()

Get the principal investigator of the collection.

Returns:

a User object representing the principal investigator

setPrincipalInvestigator

public void setPrincipalInvestigator(User principalInvestigatorIn)

Set the principal investigator of the collection.

Parameters:

principalInvestigatorIn - the principal investigator

getSpectrumIds

public int[] getSpectrumIds()

Get the spectrum identifiers in the collection.

Returns:

a reference to an array containing all of the spectrum identifiers in the collection

setSpectrumIds

public void setSpectrumIds(int[] spectrumIdsIn)

Set the spectrum identifiers in the collection. This method is required by JAXB and should not be used otherwise.