ucar.nc2.dataset

Class CoordinateTransform

java.lang.Object

ucar.nc2.dataset.CoordinateTransform

All Implemented Interfaces:

java.lang.Comparable<CoordinateTransform>

Direct Known Subclasses:

ProjectionCT, VerticalCT

@ThreadSafe
public class CoordinateTransform
extends java.lang.Object
implements java.lang.Comparable<CoordinateTransform>

A CoordinateTransform is an abstraction of a function from a CoordinateSystem to a "reference" CoordinateSystem, such as lat, lon.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	authority
protected java.lang.String	name
protected java.util.List<Parameter>	params
protected TransformType	transformType

Constructor Summary

Constructors

Constructor and Description
CoordinateTransform(java.lang.String name, java.lang.String authority, TransformType transformType) Create a Coordinate Transform.

Method Summary

Modifier and Type	Method and Description
void	addParameter(Parameter param) add a parameter
int	compareTo(CoordinateTransform oct)
boolean	equals(java.lang.Object oo) Instances which have same name, authority and parameters are equal.
Parameter	findParameterIgnoreCase(java.lang.String name) Convenience function; look up Parameter by name, ignoring case.
java.lang.String	getAuthority() get the naming authority
java.lang.String	getName() get the name
java.util.List<Parameter>	getParameters() get list of ProjectionParameter objects.
TransformType	getTransformType() get the transform type
int	hashCode() Override Object.hashCode() to be consistent with equals.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected final java.lang.String name

authority

protected final java.lang.String authority

transformType

protected final TransformType transformType

params

protected java.util.List<Parameter> params

Constructor Detail

CoordinateTransform

public CoordinateTransform(java.lang.String name,
                           java.lang.String authority,
                           TransformType transformType)

Create a Coordinate Transform.

Parameters:

name - name of transform, must be unique within the NcML.

authority - naming authority

transformType - type of transform.

Method Detail

addParameter

public void addParameter(Parameter param)

add a parameter

Parameters:

param - add this Parameter

getName

public java.lang.String getName()

get the name

Returns:

the name

getAuthority

public java.lang.String getAuthority()

get the naming authority

Returns:

the naming authority

getTransformType

public TransformType getTransformType()

get the transform type

Returns:

the transform type

getParameters

public java.util.List<Parameter> getParameters()

get list of ProjectionParameter objects.

Returns:

list of ProjectionParameter objects.

findParameterIgnoreCase

public Parameter findParameterIgnoreCase(java.lang.String name)

Convenience function; look up Parameter by name, ignoring case.

Parameters:

name - the name of the attribute

Returns:

the Attribute, or null if not found

equals

public boolean equals(java.lang.Object oo)

Instances which have same name, authority and parameters are equal.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Override Object.hashCode() to be consistent with equals.

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(CoordinateTransform oct)

Specified by:

compareTo in interface java.lang.Comparable<CoordinateTransform>