Package adams.flow.container

Class AbstractContainer

java.lang.Object

adams.flow.container.AbstractContainer

All Implemented Interfaces:

CloneHandler<Container>, GlobalInfoSupporter, SpreadSheetSupporter, Container, Serializable

Direct Known Subclasses:

AbstractFilterContainer, ControlChartContainer, EncapsulatedActorsContainer, FeatureConverterContainer, FileBasedDatasetContainer, HttpRequestResult, ImageSegmentationContainer, OutlierContainer, OutlierDetectorContainer, PredictionEccentricityContainer, ProcessActorContainer, RemoteCommandContainer, SequencePlotterContainer, SpreadSheetCellSelectionContainer, TimingContainer, TrainTestSetContainer, WekaAttributeSelectionContainer, WekaClusterEvaluationContainer, WekaClusteringContainer, WekaEvaluationContainer, WekaExperimentContainer, WekaFilterContainer, WekaForecastContainer, WekaGeneticAlgorithmContainer, WekaGeneticAlgorithmInitializationContainer, WekaModelContainer, WekaNearestNeighborSearchContainer, WekaPredictionContainer, WekaTrainTestSetContainer

public abstract class AbstractContainer
extends Object
implements Container

Ancestor of all containers. A container allows the access to the stored values via their names.

NB: containers need to declare a default constructor. The default constructor is used to generate help information.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected HashSet<String>	m_AdditionalNames	additional names for values.
protected HashMap<String,String>	m_Help	for storing the help per item.
protected HashMap<String,Object>	m_Values	for storing the values.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractContainer()	Initializes the container.

Method Summary

Modifier and Type	Method	Description
boolean	addAdditionalName(String name)	Adds the specified name as valid name for a value.
void	addHelp(String name, String desc)	Stores the help for the given name if valid name.
void	addHelp(String name, String desc, Class type)	Stores the help for the given name if valid name.
void	addHelp(String name, String desc, Class[] types)	Stores the help for the given name if valid name.
protected void	checkDefaultConstructor()	Checks whether a default constructor is available - necessary for generating HTML help.
AbstractContainer	getClone()	Returns a clone of itself using serialization.
String	getHelp(String name)	Returns the help associated with the given name.
Object	getValue(String name)	Returns the value associated with the given name.
<T> T	getValue(String name, Class<T> cls)	Returns the value associated with the given name.
String	globalInfo()	Returns a short info on the container, namely the value names.
boolean	hasHelp(String name)	Checks whether a given help is non-null.
boolean	hasValue(String name)	Checks whether a given value is non-null.
protected void	initHelp()	Initializes the help strings.
abstract boolean	isValid()	Checks whether the setup of the container is valid.
protected boolean	isValidName(String name)	Checks whether the name of the object is valid.
abstract Iterator<String>	names()	Returns all value names that can be used (theoretically).
boolean	removeAdditionalName(String name)	Removes the additional name again.
boolean	setValue(String name, Object value)	Sets the named value.
protected boolean	store(String name, Object value)	Stores the value under the name.
Iterator<String>	stored()	Returns all available stored value names.
SpreadSheet	toSpreadSheet()	Returns the content as spreadsheet.
String	toString()	Returns a short description of the stored data.

Methods inherited from class java.lang.Object

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

Field Detail

m_Values

protected HashMap<String,Object> m_Values

for storing the values.

m_AdditionalNames

protected HashSet<String> m_AdditionalNames

additional names for values.

m_Help

protected HashMap<String,String> m_Help

for storing the help per item.

Constructor Detail

AbstractContainer

protected AbstractContainer()

Initializes the container.

Method Detail

checkDefaultConstructor

protected void checkDefaultConstructor()

Checks whether a default constructor is available - necessary for generating HTML help.

getClone

public AbstractContainer getClone()

Returns a clone of itself using serialization.

Specified by:

getClone in interface CloneHandler<Container>

Specified by:

getClone in interface Container

Returns:

the clone

globalInfo

public String globalInfo()

Returns a short info on the container, namely the value names.

Specified by:

globalInfo in interface GlobalInfoSupporter

Returns:

the info

addHelp

public void addHelp(String name,
                    String desc)

Stores the help for the given name if valid name.

Specified by:

addHelp in interface Container

Parameters:

name - the name to store the help under

desc - the help description

See Also:

isValidName(String)

addHelp

public void addHelp(String name,
                    String desc,
                    Class type)

Stores the help for the given name if valid name.

Specified by:

addHelp in interface Container

Parameters:

name - the name to store the help under

desc - the help description

type - the type of the data

See Also:

isValidName(String)

addHelp

public void addHelp(String name,
                    String desc,
                    Class[] types)

Stores the help for the given name if valid name.

Specified by:

addHelp in interface Container

Parameters:

name - the name to store the help under

desc - the help description

types - the types of the data

See Also:

isValidName(String)

initHelp

protected void initHelp()

Initializes the help strings.
Default implementation does nothing.

names

public abstract Iterator<String> names()

Returns all value names that can be used (theoretically).

Specified by:

names in interface Container

Returns:

iterator over all possible value names

stored

public Iterator<String> stored()

Returns all available stored value names.

Specified by:

stored in interface Container

Returns:

enumeration over all stored value names

hasValue

public boolean hasValue(String name)

Checks whether a given value is non-null.

Specified by:

hasValue in interface Container

Parameters:

name - the name of the value to check

Returns:

true if the value is non-null

getValue

public Object getValue(String name)

Returns the value associated with the given name.

Specified by:

getValue in interface Container

Parameters:

name - the name of the value

Returns:

the associated value or null if not available

getValue

public <T> T getValue(String name,
                      Class<T> cls)

Returns the value associated with the given name.

Specified by:

getValue in interface Container

Parameters:

name - the name of the value

cls - for casting

Returns:

the associated value or null if not available

hasHelp

public boolean hasHelp(String name)

Checks whether a given help is non-null.

Specified by:

hasHelp in interface Container

Parameters:

name - the name of the help item to check

Returns:

true if the help is non-null

getHelp

public String getHelp(String name)

Returns the help associated with the given name.

Specified by:

getHelp in interface Container

Parameters:

name - the name of the help item

Returns:

the associated help or null if not available

isValidName

protected boolean isValidName(String name)

Checks whether the name of the object is valid.

Parameters:

name - the name to check

Returns:

true if valid

See Also:

names()

store

protected boolean store(String name,
                        Object value)

Stores the value under the name.

Parameters:

name - the name of the value

value - the value to store

Returns:

true if successfully stored, i.e., value is not null

setValue

public boolean setValue(String name,
                        Object value)

Sets the named value.

Specified by:

setValue in interface Container

Parameters:

name - the name of the value

value - the value to store in the container

Returns:

true if the name was recognized and the value was stored successfully, false otherwise

isValid

public abstract boolean isValid()

Checks whether the setup of the container is valid.

Specified by:

isValid in interface Container

Returns:

true if all the necessary values are available

addAdditionalName

public boolean addAdditionalName(String name)

Adds the specified name as valid name for a value.

Specified by:

addAdditionalName in interface Container

Parameters:

name - the name to add

Returns:

true if the additional names list changed

removeAdditionalName

public boolean removeAdditionalName(String name)

Removes the additional name again.

Specified by:

removeAdditionalName in interface Container

Parameters:

name - the name to remove

Returns:

true if the name was present and got removed

toString

public String toString()

Returns a short description of the stored data.

Specified by:

toString in interface Container

Overrides:

toString in class Object

Returns:

short description

toSpreadSheet

public SpreadSheet toSpreadSheet()

Returns the content as spreadsheet.

Specified by:

toSpreadSheet in interface Container

Specified by:

toSpreadSheet in interface SpreadSheetSupporter

Returns:

the content