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. CoordinateTransform is the superclass for ProjectionCT and VerticalCT. It contains the Attributes/Parameters needed to make a "Coordinate Transform Variable" which is just a container for the Transform parameters. LOOK this should be abstract.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CoordinateTransform.Builder<T extends CoordinateTransform.Builder<T>>

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

Modifier	Constructor and Description
protected	CoordinateTransform(CoordinateTransform.Builder<?> builder, NetcdfDataset ncd)
	CoordinateTransform(java.lang.String name, java.lang.String authority, TransformType transformType) Deprecated. Use CoordinateTransform.builder()
protected	CoordinateTransform(java.lang.String name, java.lang.String authority, TransformType transformType, java.util.List<Parameter> params) Create a Coordinate Transform.

Method Summary

Modifier and Type	Method and Description
protected CoordinateTransform.Builder<?>	addLocalFieldsToBuilder(CoordinateTransform.Builder<? extends CoordinateTransform.Builder<?>> b)
void	addParameter(Parameter param) Deprecated. Use CoordinateTransform.builder()
static CoordinateTransform.Builder<?>	builder() Get Builder for this class that allows subclassing.
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.
AttributeContainer	getAttributeContainer()
java.lang.String	getAuthority()
java.lang.String	getName()
com.google.common.collect.ImmutableList<Parameter>	getParameters()
TransformType	getTransformType()
int	hashCode() Override Object.hashCode() to be consistent with equals.
CoordinateTransform.Builder<?>	toBuilder()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

authority

protected java.lang.String authority

transformType

protected final TransformType transformType

params

protected java.util.List<Parameter> params

Constructor Detail

CoordinateTransform

protected CoordinateTransform(java.lang.String name,
                              java.lang.String authority,
                              TransformType transformType,
                              java.util.List<Parameter> params)

Create a Coordinate Transform.

Parameters:

name - name of transform, must be unique within the Coordinate System.

authority - naming authority

transformType - type of transform.

params - list of Parameters.

CoordinateTransform

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

Deprecated. Use CoordinateTransform.builder()

Create a Coordinate Transform.

Parameters:

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

authority - naming authority

transformType - type of transform.

CoordinateTransform

protected CoordinateTransform(CoordinateTransform.Builder<?> builder,
                              NetcdfDataset ncd)

Method Detail

addParameter

@Deprecated
public void addParameter(Parameter param)

Deprecated. Use CoordinateTransform.builder()

add a parameter

Parameters:

param - add this Parameter

getName

public java.lang.String getName()

getAttributeContainer

public AttributeContainer getAttributeContainer()

getAuthority

public java.lang.String getAuthority()

getTransformType

public TransformType getTransformType()

getParameters

public com.google.common.collect.ImmutableList<Parameter> getParameters()

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>

toBuilder

public CoordinateTransform.Builder<?> toBuilder()

addLocalFieldsToBuilder

protected CoordinateTransform.Builder<?> addLocalFieldsToBuilder(CoordinateTransform.Builder<? extends CoordinateTransform.Builder<?>> b)

builder

public static CoordinateTransform.Builder<?> builder()

Get Builder for this class that allows subclassing.

See Also:

"https://community.oracle.com/blogs/emcmanus/2010/10/24/using-builder-pattern-subclasses"