com.goldencode.p2j.persist

Class IndexDefinition

java.lang.Object

com.goldencode.p2j.persist.IndexDefinition

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class IndexDefinition
extends java.lang.Object
implements java.io.Externalizable

Container for a table index metadata. Used to send the metadata of a DMO to a remote side, when remote appserver calls are involved.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexDefinition.IndexComponentDefinition A container with an index component information.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<IndexDefinition.IndexComponentDefinition>	components Index components (fields with sorting directions).
private static int	IA_NONE Flag for default (none) index attribute.
private static int	IA_PRIMARY Flag for 'primary' / 'effective primary' index attribute.
private static int	IA_UNIQUE Flag for 'unique' index attribute.
private static int	IA_WORD Flag for 'word' index attribute.
private int	indexAttribute The collection of index attribute.
private java.lang.String	legacyName The legacy name of this index.

Constructor Summary

Constructors

Constructor and Description
IndexDefinition() Default c'tor
IndexDefinition(TableMapper.LegacyIndexInfo lii) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addTo(TempTableBuilder tb) Add current index to the TableBuilder.
void	readExternal(java.io.ObjectInput in) Read the index definition from the specified input source.
void	writeExternal(java.io.ObjectOutput out) Send the index definition to the specified output destination.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IA_NONE

private static final int IA_NONE

Flag for default (none) index attribute.

See Also:

Constant Field Values

IA_PRIMARY

private static final int IA_PRIMARY

Flag for 'primary' / 'effective primary' index attribute.

See Also:

Constant Field Values

IA_UNIQUE

private static final int IA_UNIQUE

Flag for 'unique' index attribute.

See Also:

Constant Field Values

IA_WORD

private static final int IA_WORD

Flag for 'word' index attribute.

See Also:

Constant Field Values

legacyName

private java.lang.String legacyName

The legacy name of this index.

indexAttribute

private int indexAttribute

The collection of index attribute. It is a OR-ed combination of the following flags:

• IA_PRIMARY - determines if the index is a primary index: the one with the "primary" annotation or, if there is no such one, the first in the definition order;
• IA_UNIQUE - determines if the index is a unique index;
• IA_WORD - determines if the index is a word-index index.

The collection is serialized as a single byte because there are only 3 attributes. When/if we include additional attributes and the 8 bits of the byte are not enough, we will use larger data type.

components

private java.util.List<IndexDefinition.IndexComponentDefinition> components

Index components (fields with sorting directions).

Constructor Detail

IndexDefinition

public IndexDefinition()

Default c'tor

IndexDefinition

public IndexDefinition(TableMapper.LegacyIndexInfo lii)

Constructor. Creates an IndexDefinition staring from the TableMapper legacy data.

Parameters:

lii - ORM index info

Method Detail

addTo

public void addTo(TempTableBuilder tb)

Add current index to the TableBuilder.

Parameters:

tb - TableBuilder instance.

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Read the index definition from the specified input source.

Specified by:

readExternal in interface java.io.Externalizable

Parameters:

in - The input source from which the index definition will be read.

Throws:

java.io.IOException - In case of I/O errors.

java.lang.ClassNotFoundException - If the class of property could not be found/loaded.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Send the index definition to the specified output destination.

Specified by:

writeExternal in interface java.io.Externalizable

Parameters:

out - The output destination to which the index definition will be sent.

Throws:

java.io.IOException - In case of I/O errors.