ch.specchio.types

Class Campaign

java.lang.Object

ch.specchio.types.Campaign

Direct Known Subclasses:

SpecchioCampaign

public abstract class Campaign
extends java.lang.Object

Base class for all kinds of campaign.

Constructor Summary

Constructors

Constructor and Description
Campaign() Default constructor.
Campaign(int campaign_id, java.lang.String name, java.lang.String path) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addKnownPath(java.lang.String path) Add a path to the list from which this campaign has been loaded.
Point2D	getAverage_location()
java.lang.String	getDescription() Get the campaign description.
int	getId() Get the campaign identifier.
java.lang.String	getInvestigator() Get the campaign investigator.
java.util.ArrayList<java.lang.String>	getKnownPaths() Get the list of paths from which this campaign has been loaded.
float	getMetadata_space_density()
java.lang.String	getName() Get the campaign name.
int	getNumber_of_spectra()
java.lang.String	getPath() Get the path to the campaign's data.
ResearchGroup	getResearchGroup() Get the research group.
int	getResearchGroupId()
abstract java.lang.String	getType() Get the campaign type.
int	getUser_id()
User	getUser() Get the campaign user.
boolean	isMetadata_details_loaded()
void	setAverage_location(Point2D average_location)
void	setDescription(java.lang.String description) Set the campaign description.
void	setId(int campaign_id) Set the campaign identifier.
void	setInvestigator(java.lang.String investigator) Set the campaign investigator.
void	setKnownPaths(java.util.ArrayList<java.lang.String> paths) Set the list of paths from which this campaign has been loaded.
void	setMetadata_details_loaded(boolean metadata_details_loaded)
void	setMetadata_space_density(float metadata_space_density)
void	setName(java.lang.String name) Set the campaign name.
void	setNumber_of_spectra(int number_of_spectra)
void	setPath(java.lang.String path) Set the path to the campaign data.
void	setResearchGroup(ResearchGroup research_group) Set the research group.
void	setResearchGroupId(int researchGroupId)
void	setUser_id(int user_id)
void	setUser(User user) Set the campaign user.
java.lang.String	toString() Get a string that represents the campaign.

Methods inherited from class java.lang.Object

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

Constructor Detail

Campaign

public Campaign()

Default constructor.

Campaign

public Campaign(int campaign_id,
                java.lang.String name,
                java.lang.String path)

Constructor.

Method Detail

getDescription

public java.lang.String getDescription()

Get the campaign description.

Returns:

the description of the campaign

setDescription

public void setDescription(java.lang.String description)

Set the campaign description.

Parameters:

description - the description of the campaign

getId

public int getId()

Get the campaign identifier.

Returns:

the campaign identifier

setId

public void setId(int campaign_id)

Set the campaign identifier.

Parameters:

campaign_id - campaign identifier

getInvestigator

public java.lang.String getInvestigator()

Get the campaign investigator.

Returns:

the investigator of the campaign

setInvestigator

public void setInvestigator(java.lang.String investigator)

Set the campaign investigator.

Parameters:

investigator - the investigator of the campaign

getUser

public User getUser()

Get the campaign user.

Returns:

the user of the campaign

setUser

public void setUser(User user)

Set the campaign user.

Parameters:

user - the user of the campaign

getKnownPaths

public java.util.ArrayList<java.lang.String> getKnownPaths()

Get the list of paths from which this campaign has been loaded.

Returns:

the list of paths

setKnownPaths

public void setKnownPaths(java.util.ArrayList<java.lang.String> paths)

Set the list of paths from which this campaign has been loaded.

Parameters:

paths - the list of paths

addKnownPath

public void addKnownPath(java.lang.String path)

Add a path to the list from which this campaign has been loaded.

Parameters:

path - the new path

getName

public java.lang.String getName()

Get the campaign name.

Returns:

the name of the campaign

setName

public void setName(java.lang.String name)

Set the campaign name.

Parameters:

name - the name of the campaign

getPath

public java.lang.String getPath()

Get the path to the campaign's data.

Returns:

the path to the campaign's data

setPath

public void setPath(java.lang.String path)

Set the path to the campaign data.

Parameters:

path - the path to the campaign data

getResearchGroup

public ResearchGroup getResearchGroup()

Get the research group.

Returns:

a ResearchGroup object

setResearchGroup

public void setResearchGroup(ResearchGroup research_group)

Set the research group.

Parameters:

research_group - the research group

getType

public abstract java.lang.String getType()

Get the campaign type.

Returns:

a string identifying the type of the campaign

toString

public java.lang.String toString()

Get a string that represents the campaign.

Overrides:

toString in class java.lang.Object

Returns:

the name of the campaign

getUser_id

public int getUser_id()

setUser_id

public void setUser_id(int user_id)

getResearchGroupId

public int getResearchGroupId()

setResearchGroupId

public void setResearchGroupId(int researchGroupId)

getNumber_of_spectra

public int getNumber_of_spectra()

setNumber_of_spectra

public void setNumber_of_spectra(int number_of_spectra)

getMetadata_space_density

public float getMetadata_space_density()

setMetadata_space_density

public void setMetadata_space_density(float metadata_space_density)

getAverage_location

public Point2D getAverage_location()

setAverage_location

public void setAverage_location(Point2D average_location)

isMetadata_details_loaded

public boolean isMetadata_details_loaded()

setMetadata_details_loaded

public void setMetadata_details_loaded(boolean metadata_details_loaded)