Package com.illumon.dataobjects

Class ColumnDefinition<TYPE>

java.lang.Object

com.illumon.dataobjects.generated.DefaultColumnDefinition

com.illumon.dataobjects.ColumnDefinition<TYPE>

All Implemented Interfaces:

com.fishlib.base.Copyable<DefaultColumnDefinition>, com.fishlib.base.log.LogOutputAppendable, com.fishlib.base.SafeCloneable<DefaultColumnDefinition>, com.fishlib.dataobjects.persistence.WObjectStreamConstants, com.fishlib.dataobjects.WAbstractDataObject, Externalizable, Serializable, Cloneable

Direct Known Subclasses:

ImporterColumnDefinition

public class ColumnDefinition<TYPE>
extends DefaultColumnDefinition

Column definition for all Iris columns. Adds non-stateful functionality to DefaultColumnDefinition.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ColumnDefinition.ObjectCodecType	Object codec types, allowing us to specify whether a "built-in" behavior should be used, or a codec class.
static enum	ColumnDefinition.SymbolTableType

Field Summary

Fields

Modifier and Type	Field	Description
static final com.fishlib.base.formatters.EnumFormatter	COLUMN_TYPE_FORMATTER
static final com.fishlib.base.formatters.EnumFormatter	ENCODING_FORMATTER
static final ColumnDefinition[]	ZERO_LENGTH_COLUMN_DEFINITION_ARRAY

Fields inherited from class com.illumon.dataobjects.generated.DefaultColumnDefinition

columnSet_, columnSetName_, columnType, COLUMNTYPE_GROUPING, COLUMNTYPE_NORMAL, COLUMNTYPE_PARTITIONING, COLUMNTYPE_VIRTUAL, componentType, dataType, encoding, ENCODING_ISO_8859_1, ENCODING_US_ASCII, ENCODING_UTF_16, ENCODING_UTF_16BE, ENCODING_UTF_16LE, ENCODING_UTF_8, INDEX_OF_COLUMNTYPE, INDEX_OF_COMPONENTTYPE, INDEX_OF_DATATYPE, INDEX_OF_ENCODING, INDEX_OF_ISVARSIZESTRING, INDEX_OF_NAME, INDEX_OF_OBJECTCODECARGUMENTS, INDEX_OF_OBJECTCODECCLASS, INDEX_OF_OBJECTWIDTH, isVarSizeString, name, objectCodecArguments, objectCodecClass, objectWidth

Fields inherited from interface com.fishlib.dataobjects.persistence.WObjectStreamConstants

ADD_CLASS, ADD_COLUMN_SET_CLASS, ADD_ENUM, ADD_ENUM_LONG, ADO_ARRAY_TYPE, ARRAY_TYPE, BOOLEAN_TYPE, BYTE_ARRAY_TYPE, BYTE_TYPE, DATE_TYPE, DOUBLE_ARRAY_TYPE, DOUBLE_TYPE, FLOAT_ARRAY_TYPE, FLOAT_TYPE, INT_ARRAY_TYPE, INTEGER_TYPE, KNOWN_ENUM, KNOWN_ENUM_LONG, LINKED_MAP_TYPE, LINKED_SET_TYPE, LONG_ARRAY_TYPE, LONG_STRING_TYPE, LONG_TYPE, MAP_TYPE, NULL_TYPE, OBJECT_TYPE, SET_TYPE, STRING_ARRAY_TYPE, STRING_TYPE, TREE_MAP_TYPE, TREE_SET_TYPE

Constructor Summary

Constructors

Constructor	Description
ColumnDefinition()
ColumnDefinition(ColumnDefinition source)
ColumnDefinition(String name, Class<TYPE> dataType)
ColumnDefinition(String name, Class<TYPE> dataType, int columnType)
ColumnDefinition(String name, Class<TYPE> dataType, int columnType, boolean isVarSizeString)

Method Summary

Modifier and Type	Method	Description
static void	beginPersistentSerialization()
ColumnDefinition	clone()
void	describeDifferences(@NotNull List<String> differences, @NotNull ColumnDefinition other, @NotNull String lhs, @NotNull String rhs, @NotNull String prefix)	Enumerate the differences between this ColumnDefinition, and another one.
static boolean	doingPersistentSerialization()
static void	endPersistentSerialization()
boolean	equals(Object other)
Class<TYPE>	getDataType()
com.fishlib.base.string.EncodingInfo	getEncodingInfo()
static com.fishlib.base.string.EncodingInfo	getEncodingInfo(int encoding)
ColumnDefinition.ObjectCodecType	getObjectCodecType()	Get the appropriate ObjectCodecType for this column definition.
ColumnDefinition.SymbolTableType	getSymbolTableType()
boolean	isCompatible(ColumnDefinition other)	Compares two ColumnDefinitions somewhat more permissively than equals, disregarding matters of storage and derivation.
boolean	isDirect()
boolean	isFixedWidthObjectType()
boolean	isGrouping()
boolean	isPartitioning()
void	readExternal(ObjectInput in)
ColumnDefinition	rename(String newName)
ColumnDefinition<?>	withGrouping()
ColumnDefinition<?>	withPartitioning()
void	writeExternal(ObjectOutput out)

Methods inherited from class com.illumon.dataobjects.generated.DefaultColumnDefinition

append, copyValues, getByte, getByte, getByte, getColumnSet, getColumnSetName, getColumnSetStatic, getColumnType, getComponentType, getDate, getDate, getDate, getDouble, getDouble, getDouble, getEncoding, getInt, getInt, getInt, getIsVarSizeString, getLong, getLong, getLong, getName, getObjectCodecArguments, getObjectCodecClass, getObjectWidth, getString, getString, getString, getValue, getValue, getValue, hashCode, safeClone, setByte, setByte, setColumnType, setComponentType, setDataType, setDate, setDate, setDouble, setDouble, setEncoding, setInt, setInt, setIsVarSizeString, setLong, setLong, setName, setObjectCodecArguments, setObjectCodecClass, setObjectWidth, setString, setString, setValue, setValue, toString

Methods inherited from class java.lang.Object

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

Field Details

ZERO_LENGTH_COLUMN_DEFINITION_ARRAY

public static final ColumnDefinition[] ZERO_LENGTH_COLUMN_DEFINITION_ARRAY

COLUMN_TYPE_FORMATTER

public static final com.fishlib.base.formatters.EnumFormatter COLUMN_TYPE_FORMATTER

ENCODING_FORMATTER

public static final com.fishlib.base.formatters.EnumFormatter ENCODING_FORMATTER

Constructor Details

ColumnDefinition

public ColumnDefinition()

ColumnDefinition

public ColumnDefinition(String name,
 Class<TYPE> dataType)

ColumnDefinition

public ColumnDefinition(String name,
 Class<TYPE> dataType,
 int columnType)

ColumnDefinition

public ColumnDefinition(String name,
 Class<TYPE> dataType,
 int columnType,
 boolean isVarSizeString)

ColumnDefinition

public ColumnDefinition(ColumnDefinition source)

Method Details

clone

public ColumnDefinition clone()

Specified by:

clone in interface com.fishlib.dataobjects.WAbstractDataObject

Overrides:

clone in class DefaultColumnDefinition

getDataType

public Class<TYPE> getDataType()

Overrides:

getDataType in class DefaultColumnDefinition

isGrouping

public boolean isGrouping()

isPartitioning

public boolean isPartitioning()

isDirect

public boolean isDirect()

isCompatible

public boolean isCompatible(ColumnDefinition other)

Compares two ColumnDefinitions somewhat more permissively than equals, disregarding matters of storage and derivation.

Parameters:

other - - The ColumnDefinition to compare to.

Returns:

True if the ColumnDefinition defines a column whose data is compatible with this ColumnDefinition.

describeDifferences

public void describeDifferences(@NotNull
 @NotNull List<String> differences,
 @NotNull
 @NotNull ColumnDefinition other,
 @NotNull
 @NotNull String lhs,
 @NotNull
 @NotNull String rhs,
 @NotNull
 @NotNull String prefix)

Enumerate the differences between this ColumnDefinition, and another one. Lines will be of the form "lhs attribute 'value' does not match rhs attribute 'value'.

Parameters:

differences - an array to which differences can be added

other - the ColumnDefinition under comparison

lhs - what to call "this" definition

rhs - what to call the other definition

prefix - begin each difference with this string

equals

public boolean equals(Object other)

Overrides:

equals in class DefaultColumnDefinition

rename

public ColumnDefinition rename(String newName)

withPartitioning

public ColumnDefinition<?> withPartitioning()

withGrouping

public ColumnDefinition<?> withGrouping()

getSymbolTableType

public ColumnDefinition.SymbolTableType getSymbolTableType()

getEncodingInfo

public com.fishlib.base.string.EncodingInfo getEncodingInfo()

getEncodingInfo

public static com.fishlib.base.string.EncodingInfo getEncodingInfo(int encoding)

getObjectCodecType

public ColumnDefinition.ObjectCodecType getObjectCodecType()

Get the appropriate ObjectCodecType for this column definition.

Returns:

The StandardObjectCodec, or null if none is appropriate

isFixedWidthObjectType

public boolean isFixedWidthObjectType()

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class DefaultColumnDefinition

Throws:

IOException

ClassNotFoundException

beginPersistentSerialization

public static void beginPersistentSerialization()

endPersistentSerialization

public static void endPersistentSerialization()

doingPersistentSerialization

public static boolean doingPersistentSerialization()

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class DefaultColumnDefinition

Throws:

IOException