com.datastax.driver.core

Class UserType

java.lang.Object

com.datastax.driver.core.DataType

com.datastax.driver.core.UserType

All Implemented Interfaces:

Iterable<UserType.Field>

public class UserType
extends DataType
implements Iterable<UserType.Field>

A User Defined Type (UDT).

A UDT is a essentially a named collection of fields (with a name and a type).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserType.Field A UDT field.

Nested classes/interfaces inherited from class com.datastax.driver.core.DataType

DataType.CollectionType, DataType.CustomType, DataType.Name, DataType.NativeType

Field Summary

Fields inherited from class com.datastax.driver.core.DataType

name

Method Summary

Modifier and Type	Method and Description
String	asCQLQuery() Returns a CQL query representing this user type.
String	asFunctionParameterString() Returns a String representation of this data type suitable for inclusion as a parameter type in a function or aggregate signature.
boolean	contains(String name) Returns whether this UDT contains a given field.
boolean	equals(Object o)
String	exportAsString() Returns a CQL query representing this user type in human readable form.
Collection<String>	getFieldNames() Returns the names of the fields of this UDT.
DataType	getFieldType(String name) Returns the type of a given field.
String	getKeyspace() The name of the keyspace this UDT is part of.
String	getTypeName() The name of this user type.
int	hashCode()
boolean	isFrozen() Returns whether this data type is frozen.
Iterator<UserType.Field>	iterator() Returns an iterator over the fields of this UDT.
UDTValue	newValue() Returns a new empty value for this user type definition.
int	size() Returns the number of fields in this UDT.
String	toString()

Methods inherited from class com.datastax.driver.core.DataType

allPrimitiveTypes, ascii, bigint, blob, cboolean, cdouble, cfloat, cint, counter, custom, date, decimal, frozenList, frozenMap, frozenSet, getName, getTypeArguments, inet, isCollection, list, list, map, map, set, set, smallint, text, time, timestamp, timeuuid, tinyint, uuid, varchar, varint

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

newValue

public UDTValue newValue()

Returns a new empty value for this user type definition.

Returns:

an empty value for this user type definition.

getKeyspace

public String getKeyspace()

The name of the keyspace this UDT is part of.

Returns:

the name of the keyspace this UDT is part of.

getTypeName

public String getTypeName()

The name of this user type.

Returns:

the name of this user type.

size

public int size()

Returns the number of fields in this UDT.

Returns:

the number of fields in this UDT.

contains

public boolean contains(String name)

Returns whether this UDT contains a given field.

Parameters:

name - the name to check. Note that name obey the usual CQL identifier rules: it should be quoted if it denotes a case sensitive identifier (you can use Metadata.quote(java.lang.String) for the quoting).

Returns:

true if this UDT contains a field named name, false otherwise.

iterator

public Iterator<UserType.Field> iterator()

Returns an iterator over the fields of this UDT.

Specified by:

iterator in interface Iterable<UserType.Field>

Returns:

an iterator over the fields of this UDT.

getFieldNames

public Collection<String> getFieldNames()

Returns the names of the fields of this UDT.

Returns:

the names of the fields of this UDT as a collection.

getFieldType

public DataType getFieldType(String name)

Returns the type of a given field.

Parameters:

name - the name of the field. Note that name obey the usual CQL identifier rules: it should be quoted if it denotes a case sensitive identifier (you can use Metadata.quote(java.lang.String) for the quoting).

Returns:

the type of field name if this UDT has a field of this name, null otherwise.

Throws:

IllegalArgumentException - if name is not a field of this UDT definition.

isFrozen

public boolean isFrozen()

Description copied from class: DataType

Returns whether this data type is frozen.

This applies to User Defined Types, tuples and nested collections. Frozen types are serialized as a single value in Cassandra's storage engine, whereas non-frozen types are stored in a form that allows updates to individual subfields.

Specified by:

isFrozen in class DataType

Returns:

whether this data type is frozen.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

exportAsString

public String exportAsString()

Returns a CQL query representing this user type in human readable form.

This method is equivalent to asCQLQuery() but the ouptut is formatted to be human readable (for some definition of human readable).

Returns:

the CQL query representing this user type.

asCQLQuery

public String asCQLQuery()

Returns a CQL query representing this user type.

This method returns a single 'CREATE TYPE' query corresponding to this UDT definition.

Note that the returned string is a single line; the returned query is not formatted in any way.

Returns:

the 'CREATE TYPE' query corresponding to this user type.

See Also:

exportAsString()

toString

public String toString()

Overrides:

toString in class Object

asFunctionParameterString

public String asFunctionParameterString()

Description copied from class: DataType

Returns a String representation of this data type suitable for inclusion as a parameter type in a function or aggregate signature.

In such places, the String representation might vary from the canonical one as returned by Object.toString(); e.g. the frozen keyword is not accepted.

Overrides:

asFunctionParameterString in class DataType

Returns:

a String representation of this data type suitable for inclusion as a parameter type in a function or aggregate signature.