com.luciad.datamodels

Class DataType

java.lang.Object

com.luciad.datamodels.DataType

All Implemented Interfaces:

AutoCloseable

public final class DataType
extends Object
implements AutoCloseable

A representation of the type of a data object.

A type describes the structure of a data object as a list of properties. Each of these properties is itself of a certain type.

A type is either a primitive type or a data object type. Primitive types are types which have no internal structure (no properties) and typically represent simple object such as strings, numbers etc. All primitive types are accessible from this class (see e.g. getIntType(), getStringType() ...).

Application-specific metadata can be attached to a type in the form of a DataAnnotation.

New types can be defined using a DataType.Builder (see newBuilder()).

Instances of this class are thread safe. Once an instance has been created, there is no public API to modify it.

See Also:

DataProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataType.Builder Builder that allows DataType instances to be created.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	equals(Object other)
protected void	finalize()
DataProperty	findDataProperty(String name) Searches for a data property by name.
List<DataAnnotation>	getAnnotations()
static DataType	getBooleanType()
List<DataProperty>	getDataProperties()
static DataType	getDoubleType()
static DataType	getFloatType()
static DataType	getGeometryType()
static DataType	getIntType()
static DataType	getLongType()
String	getName()
static DataType	getStringType()
boolean	hasDataProperty(DataProperty property) Checks if the given property is declared in this data type.
int	hashCode()
boolean	isPrimitive()
static DataType.Builder	newBuilder() Creates a new DataType builder.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

newBuilder

@NotNull
public static DataType.Builder newBuilder()

Creates a new DataType builder.

Returns:

a new DataType builder.

getGeometryType

@NotNull
public static DataType getGeometryType()

Returns:

type that corresponds to Geometry values.

getIntType

@NotNull
public static DataType getIntType()

Returns:

type that corresponds to int32_t values.

getLongType

@NotNull
public static DataType getLongType()

Returns:

type that corresponds to int64_t values.

getFloatType

@NotNull
public static DataType getFloatType()

Returns:

type that corresponds to float values.

getDoubleType

@NotNull
public static DataType getDoubleType()

Returns:

type that corresponds to double values.

getStringType

@NotNull
public static DataType getStringType()

Returns:

type that corresponds to std::string values.

getBooleanType

@NotNull
public static DataType getBooleanType()

Returns:

type that corresponds to bool values.

getAnnotations

@NotNull
public List<DataAnnotation> getAnnotations()

getName

@NotNull
public String getName()

getDataProperties

@NotNull
public List<DataProperty> getDataProperties()

findDataProperty

@Nullable
public DataProperty findDataProperty(@NotNull
                                               String name)

Searches for a data property by name.

Parameters:

name - the name of a property

Returns:

the data property with the given name, if available

See Also:

hasDataProperty

hasDataProperty

public boolean hasDataProperty(@NotNull
                               DataProperty property)

Checks if the given property is declared in this data type.

Parameters:

property - Data property.

Returns:

true if the data property is declared; false otherwise.

See Also:

findDataProperty

isPrimitive

public boolean isPrimitive()

Returns:

whether this is a primitive type, i.e. a type without any properties.

toString

@NotNull
public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(@Nullable
                      Object other)

Overrides:

equals in class Object