Package ucar.nc2.ft2.simpgeometry

Class SimpleGeometryFeature

java.lang.Object

ucar.nc2.ft2.simpgeometry.SimpleGeometryFeature

All Implemented Interfaces:

Comparable<VariableSimpleIF>, VariableSimpleIF

public class SimpleGeometryFeature
extends Object
implements VariableSimpleIF

SimpleGeometry - forked from Coverage.java Immutable after setCoordSys() is called.

Since:

8/13/2018

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	user

Constructor Summary

Constructors

Constructor	Description
SimpleGeometryFeature(String name, DataType dataType, AttributeContainer atts, String coordSysName, String units, String description, Object user, GeometryType geometryType)

Method Summary

Modifier and Type	Method	Description
AttributeContainer	attributes()	Attributes for the variable.
int	compareTo(VariableSimpleIF o)
Attribute	findAttributeIgnoreCase(String name)	find the attribute for the variable with the given name, ignoring case.
List<Attribute>	getAttributes()	Attributes for the variable.
SimpleGeometryCS	getCoordSys()
String	getCoordSysName()
DataType	getDataType()	Variable's data type
String	getDescription()	description of the Variable
List<Dimension>	getDimensions()	Dimension List.
String	getFullName()	full, backslash escaped name of the data Variable
String	getGeometryDescription()
GeometryType	getGeometryType()
CoordinateAxis	getIDAxis()	Retrieves the ID Axis that corresponds to this geometry.
String	getName()	Name of the data Variable.
int	getRank()	Variable rank
int[]	getShape()	Variable shape
String	getShortName()	short name of the data Variable
String	getUnitsString()	Units of the Variable.
Object	getUserObject()
CoordinateAxis	getXAxis()	Retrieves the x Axis that corresponds to this geometry.
CoordinateAxis	getYAxis()	Retrieves the y Axis that corresponds to this geometry.
CoordinateAxis	getZAxis()	Retrieves the z Axis that corresponds to this geometry.
SimpleGeometry	readGeometry(int index)	Get the data associated with the index
void	setCoordSys(SimpleGeometryCS coordSys)
String	toString()
void	toString(Formatter f, Indent indent)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

user

protected final Object user

Constructor Detail

SimpleGeometryFeature

public SimpleGeometryFeature(String name,
                             DataType dataType,
                             AttributeContainer atts,
                             String coordSysName,
                             String units,
                             String description,
                             Object user,
                             GeometryType geometryType)

Parameters:

name - name of the feature

dataType - data type

atts - list of attriburtes

coordSysName - name of the coordinate system

units - units to be used

description - description of the feature

user - user responsible for feature

geometryType - type of geometry

Method Detail

setCoordSys

public void setCoordSys(SimpleGeometryCS coordSys)

getName

public String getName()

Description copied from interface: VariableSimpleIF

Name of the data Variable. Not that this is technically ambiguous v-a-v short or full name; however, since this is a Variable interface, one must assume that it is intended to be getFullName().

Specified by:

getName in interface VariableSimpleIF

Returns:

name of the data Variable

getDataType

public DataType getDataType()

Description copied from interface: VariableSimpleIF

Variable's data type

Specified by:

getDataType in interface VariableSimpleIF

Returns:

Variable's data type

attributes

public AttributeContainer attributes()

Description copied from interface: VariableSimpleIF

Attributes for the variable.

Specified by:

attributes in interface VariableSimpleIF

getAttributes

public List<Attribute> getAttributes()

Description copied from interface: VariableSimpleIF

Attributes for the variable.

Specified by:

getAttributes in interface VariableSimpleIF

Returns:

List of type ucar.nc2.Attribute

findAttributeIgnoreCase

public Attribute findAttributeIgnoreCase(String name)

Description copied from interface: VariableSimpleIF

find the attribute for the variable with the given name, ignoring case.

Specified by:

findAttributeIgnoreCase in interface VariableSimpleIF

Parameters:

name - attribute name

Returns:

the attribute for the variable with the given name, or null if not found.

getUnitsString

public String getUnitsString()

Description copied from interface: VariableSimpleIF

Units of the Variable. These should be udunits compatible if possible

Specified by:

getUnitsString in interface VariableSimpleIF

Returns:

Units of the Variable, or null if none.

getDescription

public String getDescription()

Description copied from interface: VariableSimpleIF

description of the Variable

Specified by:

getDescription in interface VariableSimpleIF

Returns:

description of the Variable, or null if none.

getCoordSysName

public String getCoordSysName()

getUserObject

public Object getUserObject()

getGeometryType

public GeometryType getGeometryType()

getGeometryDescription

public String getGeometryDescription()

toString

public String toString()

Overrides:

toString in class Object

toString

public void toString(Formatter f,
                     Indent indent)

getCoordSys

@Nonnull
public SimpleGeometryCS getCoordSys()

getXAxis

public CoordinateAxis getXAxis()

Retrieves the x Axis that corresponds to this geometry.

Returns:

x axis

getYAxis

public CoordinateAxis getYAxis()

Retrieves the y Axis that corresponds to this geometry.

Returns:

y axis

getZAxis

public CoordinateAxis getZAxis()

Retrieves the z Axis that corresponds to this geometry.

Returns:

z axis

getIDAxis

public CoordinateAxis getIDAxis()

Retrieves the ID Axis that corresponds to this geometry.

Returns:

id axis

readGeometry

public SimpleGeometry readGeometry(int index)

Get the data associated with the index

Parameters:

index - number associated with the geometry

getFullName

public String getFullName()

Description copied from interface: VariableSimpleIF

full, backslash escaped name of the data Variable

Specified by:

getFullName in interface VariableSimpleIF

Returns:

full, backslash escaped name of the data Variable

getShortName

public String getShortName()

Description copied from interface: VariableSimpleIF

short name of the data Variable

Specified by:

getShortName in interface VariableSimpleIF

Returns:

short name of the data Variable

getRank

public int getRank()

Description copied from interface: VariableSimpleIF

Variable rank

Specified by:

getRank in interface VariableSimpleIF

Returns:

Variable rank

getShape

public int[] getShape()

Description copied from interface: VariableSimpleIF

Variable shape

Specified by:

getShape in interface VariableSimpleIF

Returns:

Variable shape

getDimensions

public List<Dimension> getDimensions()

Description copied from interface: VariableSimpleIF

Dimension List. empty for a scalar variable.

Specified by:

getDimensions in interface VariableSimpleIF

Returns:

List of ucar.nc2.Dimension, ImmutableList in ver6

compareTo

public int compareTo(@Nonnull
                     VariableSimpleIF o)

Specified by:

compareTo in interface Comparable<VariableSimpleIF>