Package nz.org.riskscape.engine.output

Class SinkParameters

java.lang.Object

nz.org.riskscape.engine.output.SinkParameters

public class SinkParameters
extends Object

Defines options that are useful when constructing a Sink

TODO the name of this might need to change to something aligned with what it's actually used for - saving

Constructor Summary

Constructors

Constructor	Description
SinkParameters(String name, Struct type)
SinkParameters(String name, Struct type, Optional<Format> format, StructDeclaration options)	Creates a new SinkParameters instance.
SinkParameters(SinkParameters clone)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Optional<Format>	getFormat()	A format the user has asked the data to be saved in
String	getName()	A name associate with the Sink.
StructDeclaration	getOptions()	Options for the given format.
Struct	getType()	The type of the data that the sink is going to receive via Sink.accept(nz.org.riskscape.engine.Tuple).
int	hashCode()
void	setFormat(Optional<Format> format)	A format the user has asked the data to be saved in
void	setName(String name)	A name associate with the Sink.
void	setOptions(StructDeclaration options)	Options for the given format.
void	setType(Struct type)	The type of the data that the sink is going to receive via Sink.accept(nz.org.riskscape.engine.Tuple).
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SinkParameters

public SinkParameters(String name,
 Struct type)

SinkParameters

public SinkParameters(SinkParameters clone)

SinkParameters

public SinkParameters(String name,
 Struct type,
 Optional<Format> format,
 StructDeclaration options)

Creates a new SinkParameters instance.

Parameters:

name - A name associate with the Sink. If this sink is saving output, then this is going to be used as the name of the output, i.e it'll be part of the resulting filename

type - The type of the data that the sink is going to receive via Sink.accept(nz.org.riskscape.engine.Tuple).

format - A format the user has asked the data to be saved in

options - Options for the given format.

Should only be included if format is given and should be of the type Format#getWriterOptionsClass().

Method Details

getName

public String getName()

A name associate with the Sink. If this sink is saving output, then this is going to be used as the name of the output, i.e it'll be part of the resulting filename

getType

public Struct getType()

The type of the data that the sink is going to receive via Sink.accept(nz.org.riskscape.engine.Tuple).

getFormat

public Optional<Format> getFormat()

A format the user has asked the data to be saved in

getOptions

public StructDeclaration getOptions()

Options for the given format.

Should only be included if format is given and should be of the type Format#getWriterOptionsClass().

setName

public void setName(String name)

A name associate with the Sink. If this sink is saving output, then this is going to be used as the name of the output, i.e it'll be part of the resulting filename

setType

public void setType(Struct type)

The type of the data that the sink is going to receive via Sink.accept(nz.org.riskscape.engine.Tuple).

setFormat

public void setFormat(Optional<Format> format)

A format the user has asked the data to be saved in

setOptions

public void setOptions(StructDeclaration options)

Options for the given format.

Should only be included if format is given and should be of the type Format#getWriterOptionsClass().

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object