ucar.nc2

Class Attribute

java.lang.Object

ucar.nc2.CDMNode

ucar.nc2.Attribute

public class Attribute
extends ucar.nc2.CDMNode

An Attribute is a name and a value, used for associating arbitrary metadata with another object. The value can be a one dimensional array of Strings or numeric values.

TODO Attributes will be immutable in 6. TODO Attribute will not extend CDMNode in 6. TODO Attribute will not know who it belongs to in 6 (Group or Variable). TODO Attribute.getFullName() will not exist in 6.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Attribute.Builder A builder for Attributes

Constructor Summary

Constructors

Constructor and Description
Attribute(java.lang.String name, java.lang.Number val) Create a scalar, signed, numeric-valued Attribute.
Attribute(java.lang.String name, java.lang.String val) Create a String-valued Attribute.

Method Summary

Modifier and Type	Method and Description
static Attribute.Builder	builder() Create an Attribute builder.
static Attribute.Builder	builder(java.lang.String name) Create an Attribute builder with the given Attribute name.
boolean	equals(java.lang.Object o) Instances which have same content are equal.
DataType	getDataType() Get the data type of the Attribute value.
EnumTypedef	getEnumType() Get the EnumTypedef of the Attribute value, if DataType is an ENUM.
int	getLength() Get the length of the array of values
java.lang.String	getName() Get the Attribute name.
java.lang.Number	getNumericValue() Retrieve numeric value.
java.lang.Number	getNumericValue(int index) Retrieve a numeric value by index.
java.lang.String	getStringValue() Retrieve String value; only call if isString() is true.
java.lang.String	getStringValue(int index) Retrieve ith String value; only call if isString() is true.
java.lang.Object	getValue(int index) Get the value as an Object.
Array	getValues() Get the value as an Array.
int	hashCode() Override Object.hashCode() to implement equals.
boolean	isArray() True if value is an array (getLength() > 1)
boolean	isString() True if value is of type String and not null.
Attribute.Builder	toBuilder() Turn into a mutable Builder.
java.lang.String	toString()

Methods inherited from class ucar.nc2.CDMNode

getShortName

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Attribute

public Attribute(java.lang.String name,
                 java.lang.Number val)

Create a scalar, signed, numeric-valued Attribute.

Parameters:

name - name of Attribute

val - value of Attribute

Attribute

public Attribute(java.lang.String name,
                 java.lang.String val)

Create a String-valued Attribute.

Parameters:

name - name of Attribute

val - value of Attribute

Method Detail

builder

public static Attribute.Builder builder()

Create an Attribute builder.

builder

public static Attribute.Builder builder(java.lang.String name)

Create an Attribute builder with the given Attribute name.

equals

public boolean equals(java.lang.Object o)

Instances which have same content are equal.

Overrides:

equals in class java.lang.Object

getDataType

public DataType getDataType()

Get the data type of the Attribute value.

getEnumType

@Nullable
public EnumTypedef getEnumType()

Get the EnumTypedef of the Attribute value, if DataType is an ENUM.

getLength

public int getLength()

Get the length of the array of values

Returns:

number of elements in the array.

getName

public java.lang.String getName()

Get the Attribute name. Not deprecated in version 5 for Attribute.

Overrides:

getName in class ucar.nc2.CDMNode

getNumericValue

@Nullable
public java.lang.Number getNumericValue()

Retrieve numeric value. Equivalent to getNumericValue(0)

Returns:

the first element of the value array, or null if its a String that cant be converted.

getNumericValue

@Nullable
public java.lang.Number getNumericValue(int index)

Retrieve a numeric value by index. If it's a String, it will try to parse it as a double.

Parameters:

index - the index into the value array.

Returns:

Number value[index], or null if its a non-parseable String or the index is out of range.

getStringValue

@Nullable
public java.lang.String getStringValue()

Retrieve String value; only call if isString() is true.

Returns:

String if this is a String valued attribute, else null.

See Also:

isString()

getStringValue

@Nullable
public java.lang.String getStringValue(int index)

Retrieve ith String value; only call if isString() is true.

Parameters:

index - which index

Returns:

ith String value (if this is a String valued attribute and index in range), else null.

See Also:

isString()

getValue

@Nullable
public java.lang.Object getValue(int index)

Get the value as an Object.

Parameters:

index - which index

Returns:

ith value as an Object.

getValues

@Nullable
public Array getValues()

Get the value as an Array.

Returns:

Array of values.

hashCode

public int hashCode()

Override Object.hashCode() to implement equals.

Overrides:

hashCode in class java.lang.Object

isArray

public boolean isArray()

True if value is an array (getLength() > 1)

Returns:

if its an array.

isString

public boolean isString()

True if value is of type String and not null.

Returns:

if its a String and not null.

toBuilder

public Attribute.Builder toBuilder()

Turn into a mutable Builder. Can use toBuilder().build() to copy.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object