Package mil.nga.crs.operation

Class OperationParameter

java.lang.Object

mil.nga.crs.operation.OperationParameter

All Implemented Interfaces:

Identifiable

public class OperationParameter
extends Object
implements Identifiable

Operation Parameter

Author:

osbornb

Constructor Summary

Constructors

Constructor	Description
OperationParameter()	Constructor
OperationParameter(String name, double value)	Constructor
OperationParameter(String name, double value, Unit unit)	Constructor
OperationParameter(String name, String fileName)	Constructor
OperationParameter(String name, String value, Unit unit)	Constructor
OperationParameter(OperationParameters parameter, double value)	Constructor
OperationParameter(OperationParameters parameter, double value, Unit unit)	Constructor
OperationParameter(OperationParameters parameter, String value)	Constructor
OperationParameter(OperationParameters parameter, String value, Unit unit)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addIdentifier(Identifier identifier)	Add the identifier
void	addIdentifiers(List<Identifier> identifiers)	Add the identifiers
boolean	equals(Object obj)
String	getFileName()	Get the file name
Identifier	getIdentifier(int index)	Get the identifier at the index
List<Identifier>	getIdentifiers()	Get the identifiers
String	getName()	Get the name
OperationParameters	getParameter()	Get the commonly known parameter type
Unit	getUnit()	Get the unit
double	getValue()	Get the value
String	getValueText()	Get the value text
int	hashCode()
boolean	hasIdentifiers()	Has identifiers
boolean	hasParameter()	Is a commonly known parameter type
boolean	hasUnit()	Has a unit
boolean	isFile()	Is a parameter file
int	numIdentifiers()	Number of identifiers
void	setFileName(String fileName)	Set the file name
void	setIdentifiers(List<Identifier> identifiers)	Set the identifiers
void	setName(String name)	Set the name
void	setParameter(OperationParameters parameter)	Set the commonly known parameter type
void	setUnit(Unit unit)	Set the unit
void	setValue(double value)	Set the value
void	setValue(String value)	Set the value
String	toString()
void	updateParameter()	Update the commonly known parameter type using the name

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationParameter

public OperationParameter()

Constructor

OperationParameter

public OperationParameter(String name,
                          double value)

Constructor

Parameters:

name - name

value - value

OperationParameter

public OperationParameter(String name,
                          double value,
                          Unit unit)

Constructor

Parameters:

name - name

value - value

unit - unit

OperationParameter

public OperationParameter(String name,
                          String value,
                          Unit unit)

Constructor

Parameters:

name - name

value - value

unit - unit

Since:

1.1.0

OperationParameter

public OperationParameter(OperationParameters parameter,
                          double value)

Constructor

Parameters:

parameter - operation parameter

value - value

OperationParameter

public OperationParameter(OperationParameters parameter,
                          String value)

Constructor

Parameters:

parameter - operation parameter

value - value

Since:

1.1.0

OperationParameter

public OperationParameter(OperationParameters parameter,
                          double value,
                          Unit unit)

Constructor

Parameters:

parameter - operation parameter

value - value

unit - unit

OperationParameter

public OperationParameter(OperationParameters parameter,
                          String value,
                          Unit unit)

Constructor

Parameters:

parameter - operation parameter

value - value

unit - unit

Since:

1.1.0

OperationParameter

public OperationParameter(String name,
                          String fileName)

Constructor

Parameters:

name - name

fileName - file name

Method Detail

getName

public String getName()

Get the name

Returns:

name

setName

public void setName(String name)

Set the name

Parameters:

name - name

getValue

public double getValue()

Get the value

Returns:

value

getValueText

public String getValueText()

Get the value text

Returns:

value text

Since:

1.1.0

setValue

public void setValue(double value)

Set the value

Parameters:

value - value

setValue

public void setValue(String value)

Set the value

Parameters:

value - value

Since:

1.1.0

getUnit

public Unit getUnit()

Get the unit

Returns:

unit

hasUnit

public boolean hasUnit()

Has a unit

Returns:

true if has unit

setUnit

public void setUnit(Unit unit)

Set the unit

Parameters:

unit - unit

getFileName

public String getFileName()

Get the file name

Returns:

file name

isFile

public boolean isFile()

Is a parameter file

Returns:

true if file

setFileName

public void setFileName(String fileName)

Set the file name

Parameters:

fileName - file name

getIdentifiers

public List<Identifier> getIdentifiers()

Get the identifiers

Specified by:

getIdentifiers in interface Identifiable

Returns:

identifiers

hasIdentifiers

public boolean hasIdentifiers()

Has identifiers

Specified by:

hasIdentifiers in interface Identifiable

Returns:

true if has identifiers

numIdentifiers

public int numIdentifiers()

Number of identifiers

Specified by:

numIdentifiers in interface Identifiable

Returns:

identifiers count

getIdentifier

public Identifier getIdentifier(int index)

Get the identifier at the index

Specified by:

getIdentifier in interface Identifiable

Parameters:

index - identifier index

Returns:

identifier

setIdentifiers

public void setIdentifiers(List<Identifier> identifiers)

Set the identifiers

Specified by:

setIdentifiers in interface Identifiable

Parameters:

identifiers - identifiers

addIdentifier

public void addIdentifier(Identifier identifier)

Add the identifier

Specified by:

addIdentifier in interface Identifiable

Parameters:

identifier - identifier

addIdentifiers

public void addIdentifiers(List<Identifier> identifiers)

Add the identifiers

Specified by:

addIdentifiers in interface Identifiable

Parameters:

identifiers - identifiers

getParameter

public OperationParameters getParameter()

Get the commonly known parameter type

Returns:

parameter type or null

hasParameter

public boolean hasParameter()

Is a commonly known parameter type

Returns:

true if has common parameter type

setParameter

public void setParameter(OperationParameters parameter)

Set the commonly known parameter type

Parameters:

parameter - parameter type or null

updateParameter

public void updateParameter()

Update the commonly known parameter type using the name

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object