ucar.nc2.dataset
Class CoordinateTransform

java.lang.Object
  extended by ucar.nc2.dataset.CoordinateTransform
All Implemented Interfaces:
Comparable
Direct Known Subclasses:
ProjectionCT, VerticalCT

@ThreadSafe
public class CoordinateTransform
extends Object
implements Comparable

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

Author:
caron

Field Summary
protected  String authority
           
protected  String name
           
protected  List<Parameter> params
           
protected  TransformType transformType
           
 
Constructor Summary
CoordinateTransform(String name, String authority, TransformType transformType)
          Create a Coordinate Transform.
 
Method Summary
 void addParameter(Parameter param)
          add a parameter
 int compareTo(Object o)
           
 boolean equals(Object oo)
          Instances which have same name, authority and parameters are equal.
 Parameter findParameterIgnoreCase(String name)
          Convenience function; look up Parameter by name, ignoring case.
 String getAuthority()
          get the naming authority
 String getName()
          get the name
 List<Parameter> getParameters()
          get list of ProjectionParameter objects.
 TransformType getTransformType()
          get the transform type
 int hashCode()
          Override Object.hashCode() to be consistent with equals.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

name

protected final String name

authority

protected final String authority

transformType

protected final TransformType transformType

params

protected List<Parameter> params
Constructor Detail

CoordinateTransform

public CoordinateTransform(String name,
                           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 String getName()
get the name

Returns:
the name

getAuthority

public String getAuthority()
get the naming authority

Returns:
the naming authority

getTransformType

public TransformType getTransformType()
get the transform type

Returns:
the transform type

getParameters

public List<Parameter> getParameters()
get list of ProjectionParameter objects.

Returns:
list of ProjectionParameter objects.

findParameterIgnoreCase

public Parameter findParameterIgnoreCase(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(Object oo)
Instances which have same name, authority and parameters are equal.

Overrides:
equals in class Object

hashCode

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

Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object

compareTo

public int compareTo(Object o)
Specified by:
compareTo in interface Comparable


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.