com.impossibl.postgres.types

Class Type

java.lang.Object

com.impossibl.postgres.types.Type

Direct Known Subclasses:

ArrayType, BaseType, CompositeType, DomainType, EnumerationType, PsuedoType, RangeType

public abstract class Type
extends Object

Represents a single type in the databases known types table. Type is the base of a hierarchy that mirrors the kinds of types they represent. NOTE: A Type, or one of its derived types, represents a single entry in the "pg_type" table.

Author:

kdubb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Type.Category
static class	Type.Codec A pair of related interface methods to encode/decode a type in a specific format.

Constructor Summary

Constructors

Constructor and Description
Type()
Type(int id, String name, Short length, Byte alignment, Type.Category category, char delimeter, int arrayTypeId, Type.Codec binaryCodec, Type.Codec textCodec)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Byte	getAlignment()
static Byte	getAlignment(Character align) Translates a protocol alignment id into a specific number of bytes.
int	getArrayTypeId()
Type.Codec	getBinaryCodec()
Type.Category	getCategory()
Type.Codec	getCodec(ResultField.Format format)
char	getDelimeter()
int	getId()
Class<?>	getJavaType(ResultField.Format format, Map<String,Class<?>> customizations)
Short	getLength()
Modifiers.Parser	getModifierParser()
String	getName()
String	getNamespace()
ResultField.Format	getParameterFormat()
ResultField.Format	getPreferredFormat()
PrimitiveType	getPrimitiveType()
int	getRelationId()
ResultField.Format	getResultFormat()
Type.Codec	getTextCodec()
int	hashCode()
boolean	isParameterFormatSupported(ResultField.Format format)
boolean	isResultFormatSupported(ResultField.Format format)
void	load(PgType.Row source, Collection<PgAttribute.Row> attrs, Registry registry) Load this type from a "pg_type" table entry and, if available, a collection of "pg_attribute" table entries.
void	setAlignment(Byte alignment)
void	setArrayTypeId(int arrayTypeId)
void	setBinaryCodec(Type.Codec binaryCodec)
void	setCategory(Type.Category category)
void	setDelimeter(char delimeter)
void	setId(int id)
void	setLength(Short length)
void	setModifierParser(Modifiers.Parser modifierParser)
void	setName(String name)
void	setNamespace(String namespace)
void	setRelationId(int relationId)
void	setTextCodec(Type.Codec textCodec)
String	toString()
Type	unwrap() Strips all "wrapping" type (e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

Type

public Type()

Type

public Type(int id,
    String name,
    Short length,
    Byte alignment,
    Type.Category category,
    char delimeter,
    int arrayTypeId,
    Type.Codec binaryCodec,
    Type.Codec textCodec)

Method Detail

getId

public int getId()

setId

public void setId(int id)

getName

public String getName()

setName

public void setName(String name)

getNamespace

public String getNamespace()

setNamespace

public void setNamespace(String namespace)

getLength

public Short getLength()

setLength

public void setLength(Short length)

getAlignment

public Byte getAlignment()

setAlignment

public void setAlignment(Byte alignment)

getCategory

public Type.Category getCategory()

setCategory

public void setCategory(Type.Category category)

getDelimeter

public char getDelimeter()

setDelimeter

public void setDelimeter(char delimeter)

getArrayTypeId

public int getArrayTypeId()

setArrayTypeId

public void setArrayTypeId(int arrayTypeId)

getBinaryCodec

public Type.Codec getBinaryCodec()

setBinaryCodec

public void setBinaryCodec(Type.Codec binaryCodec)

getTextCodec

public Type.Codec getTextCodec()

setTextCodec

public void setTextCodec(Type.Codec textCodec)

getCodec

public Type.Codec getCodec(ResultField.Format format)

getModifierParser

public Modifiers.Parser getModifierParser()

setModifierParser

public void setModifierParser(Modifiers.Parser modifierParser)

getRelationId

public int getRelationId()

setRelationId

public void setRelationId(int relationId)

unwrap

public Type unwrap()

Strips all "wrapping" type (e.g. arrays, domains) and returns the base type

Returns:

Base type after all unwrapping

getPrimitiveType

public PrimitiveType getPrimitiveType()

getJavaType

public Class<?> getJavaType(ResultField.Format format,
                   Map<String,Class<?>> customizations)

getPreferredFormat

public ResultField.Format getPreferredFormat()

isParameterFormatSupported

public boolean isParameterFormatSupported(ResultField.Format format)

getParameterFormat

public ResultField.Format getParameterFormat()

isResultFormatSupported

public boolean isResultFormatSupported(ResultField.Format format)

getResultFormat

public ResultField.Format getResultFormat()

load

public void load(PgType.Row source,
        Collection<PgAttribute.Row> attrs,
        Registry registry)

Load this type from a "pg_type" table entry and, if available, a collection of "pg_attribute" table entries.

Parameters:

source - The "pg_type" table entry

attrs - Associated "pg_attribute" table entries, if available.

registry - The registry that is loading the type.

getAlignment

public static Byte getAlignment(Character align)

Translates a protocol alignment id into a specific number of bytes.

Parameters:

align - Alignment ID

Returns:

# of bytes to align on

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object