com.northconcepts.datapipeline.foundations.schema

Class IndexDef

java.lang.Object

com.northconcepts.datapipeline.foundations.core.Bean

com.northconcepts.datapipeline.foundations.core.FoundationObject

com.northconcepts.datapipeline.foundations.schema.SchemaObject

com.northconcepts.datapipeline.foundations.schema.SchemaPart

com.northconcepts.datapipeline.foundations.schema.IndexDef

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, SchemaProblemsSupplier, JavaCodeGenerator, Serializable, Cloneable

public class IndexDef
extends SchemaPart
implements Cloneable, SchemaProblemsSupplier, JavaCodeGenerator

The metadata model for an entity's index.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject

internalId, internalName, log, TIMESTAMP_FORMAT

Fields inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

SERIALIZED_CLASS_NAME, TYPE

Fields inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

XML_SERIALIZED_CLASS_NAME

Constructor Summary

Constructors

Constructor and Description
IndexDef()
IndexDef(String name, String... indexFieldNames)

Method Summary

Modifier and Type	Method and Description
IndexDef	addIndexField(IndexFieldDef indexField)
IndexDef	addIndexFields(String... indexFieldNames)
IndexDef	clone()
boolean	containsField(String name) Returns true if this index contains an IndexFieldDef with the specified name.
boolean	equals(Object obj)
IndexDef	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
IndexDef	fromXmlElement(Element indexDefElement)
void	generateJavaCode(JavaCodeBuilder code)
String	getDescription()
EntityDef	getEntityDef()
String	getEntityQualifiedName() Returns the qualified name that includes the name of this index and the EntityDef above it separated by period.
IndexFieldDef	getIndexField(String name) Returns the IndexFieldDef that matches the specified name.
int	getIndexFieldCount() Returns the number of index fields in this index.
List<String>	getIndexFieldNames() Returns the names of all index fields in this index.
List<IndexFieldDef>	getIndexFields()
List<IndexFieldDef>	getIndexFields(boolean create)
String	getName()
String	getQualifiedName() Returns the fully qualified name that includes the name of this index and all names in its hierarchy separated by period.
SchemaDef	getSchemaDef() The schema of the parent entity containing this field.
SchemaDef	getSchemaDef(boolean throwException)
SchemaPart	getSchemaPartContainer()
String	getSchemaPartName()
SchemaPartType	getSchemaPartType()
void	getSchemaProblems(List<SchemaProblem> problems, boolean includeChildren)
int	hashCode()
int	indexOfField(String indexFieldName) Returns the zero-based position of the IndexDef with the specified name or -1 if it is not found.
int	indexOfField(String indexFieldName, boolean throwExceptionOnFailure) Returns the zero-based position of the IndexFieldDef with the specified name or -1 if it is not found and throwExceptionOnFailure is false, otherwise a DataException is thrown.
boolean	isPrimaryKeyIndex()
boolean	isUnique()
void	moveField(int oldIndex, int newIndex) Moves the index field at the oldIndex to the newIndex, shifting any existing elements at or after newIndex to the right.
void	moveField(String fieldName, int newIndex) Moves the index field with the given name to the newIndex, shifting any existing elements at or after newIndex to the right.
void	moveFieldAfter(String fieldName, String afterFieldName) Moves the index field with the given fieldName after to the index field with the specified afterFieldName, shifting any existing elements after afterFieldName to the right.
void	moveFieldBefore(String fieldName, String beforeFieldName) Moves the index field with the given fieldName before to the index field with the specified beforeFieldName, shifting elements at or after beforeFieldName to the right.
IndexDef	setDescription(String description)
protected IndexDef	setEntityDef(EntityDef entityDef)
IndexDef	setIndexFields(List<IndexFieldDef> indexFields)
IndexDef	setName(String name)
IndexDef	setUnique(boolean unique)
String	toJson()
Record	toRecord()
Element	toXmlElement(Document document)

Methods inherited from class com.northconcepts.datapipeline.foundations.schema.SchemaPart

getSchemaName, getSchemaPartContainerName, getSchemaPartContainerType

Methods inherited from class com.northconcepts.datapipeline.foundations.core.FoundationObject

addExceptionProperties, assertValid, assertValid, exception, exception, exception, getInternalId, getInternalName, resetInternalId

Methods inherited from class com.northconcepts.datapipeline.foundations.core.Bean

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.northconcepts.datapipeline.foundations.schema.SchemaProblemsSupplier

getSchemaProblems, getSchemaProblems

Methods inherited from interface com.northconcepts.datapipeline.core.RecordSerializable

fromArrayValue, fromArrayValue, fromArrayValue, fromJson, fromJson, newInstanceFromRecord, newInstanceFromRecord, toArrayValue, toJson, toJson, toRecord

Methods inherited from interface com.northconcepts.datapipeline.core.JsonSerializable

newInstanceFromJson

Methods inherited from interface com.northconcepts.datapipeline.core.XmlSerializable

forEachGrandChildElement, fromXml, fromXml, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getAttribute, getChildElement, getChildElements, newInstanceFromXml, newInstanceFromXml, setAttribute, toXml, toXml, toXml, toXml, toXml, writeXml, writeXml

Methods inherited from interface com.northconcepts.datapipeline.core.DataExceptionContributor

addExceptionProperties, contributeExceptionProperties, contributeExceptionProperties

Constructor Detail

IndexDef

public IndexDef()

IndexDef

public IndexDef(String name,
                String... indexFieldNames)

Method Detail

getSchemaProblems

public void getSchemaProblems(List<SchemaProblem> problems,
                              boolean includeChildren)

Specified by:

getSchemaProblems in interface SchemaProblemsSupplier

clone

public IndexDef clone()

Overrides:

clone in class FoundationObject

generateJavaCode

public void generateJavaCode(JavaCodeBuilder code)

Specified by:

generateJavaCode in interface JavaCodeGenerator

getSchemaDef

public SchemaDef getSchemaDef(boolean throwException)

getSchemaDef

public SchemaDef getSchemaDef()

The schema of the parent entity containing this field.

Specified by:

getSchemaDef in class SchemaPart

getSchemaPartContainer

public SchemaPart getSchemaPartContainer()

Specified by:

getSchemaPartContainer in class SchemaPart

getSchemaPartType

public SchemaPartType getSchemaPartType()

Specified by:

getSchemaPartType in class SchemaPart

getSchemaPartName

public String getSchemaPartName()

Specified by:

getSchemaPartName in class SchemaPart

getEntityDef

public EntityDef getEntityDef()

setEntityDef

protected IndexDef setEntityDef(EntityDef entityDef)

getName

public String getName()

setName

public IndexDef setName(String name)

getQualifiedName

public String getQualifiedName()

Returns the fully qualified name that includes the name of this index and all names in its hierarchy separated by period.

getEntityQualifiedName

public String getEntityQualifiedName()

Returns the qualified name that includes the name of this index and the EntityDef above it separated by period.

getDescription

public String getDescription()

setDescription

public IndexDef setDescription(String description)

isUnique

public boolean isUnique()

setUnique

public IndexDef setUnique(boolean unique)

isPrimaryKeyIndex

public boolean isPrimaryKeyIndex()

containsField

public boolean containsField(String name)

Returns true if this index contains an IndexFieldDef with the specified name.

getIndexFieldCount

public int getIndexFieldCount()

Returns the number of index fields in this index.

getIndexFieldNames

public List<String> getIndexFieldNames()

Returns the names of all index fields in this index.

getIndexFields

public List<IndexFieldDef> getIndexFields(boolean create)

getIndexField

public IndexFieldDef getIndexField(String name)

Returns the IndexFieldDef that matches the specified name.

getIndexFields

public List<IndexFieldDef> getIndexFields()

setIndexFields

public IndexDef setIndexFields(List<IndexFieldDef> indexFields)

addIndexField

public IndexDef addIndexField(IndexFieldDef indexField)

addIndexFields

public IndexDef addIndexFields(String... indexFieldNames)

toXmlElement

public Element toXmlElement(Document document)

Specified by:

toXmlElement in interface XmlSerializable

fromXmlElement

public IndexDef fromXmlElement(Element indexDefElement)

Specified by:

fromXmlElement in interface XmlSerializable

toJson

public String toJson()

Specified by:

toJson in interface JsonSerializable

Specified by:

toJson in interface RecordSerializable

toRecord

public Record toRecord()

Specified by:

toRecord in interface RecordSerializable

Overrides:

toRecord in class Bean

fromRecord

public IndexDef fromRecord(Record source)

Description copied from interface: RecordSerializable

Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.

Specified by:

fromRecord in interface RecordSerializable

Overrides:

fromRecord in class Bean

Returns:

this instance.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

indexOfField

public int indexOfField(String indexFieldName)

Returns the zero-based position of the IndexDef with the specified name or -1 if it is not found.

indexOfField

public int indexOfField(String indexFieldName,
                        boolean throwExceptionOnFailure)

Returns the zero-based position of the IndexFieldDef with the specified name or -1 if it is not found and throwExceptionOnFailure is false, otherwise a DataException is thrown.

moveField

public void moveField(int oldIndex,
                      int newIndex)

Moves the index field at the oldIndex to the newIndex, shifting any existing elements at or after newIndex to the right.

moveField

public void moveField(String fieldName,
                      int newIndex)

Moves the index field with the given name to the newIndex, shifting any existing elements at or after newIndex to the right.

moveFieldBefore

public void moveFieldBefore(String fieldName,
                            String beforeFieldName)

Moves the index field with the given fieldName before to the index field with the specified beforeFieldName, shifting elements at or after beforeFieldName to the right.

moveFieldAfter

public void moveFieldAfter(String fieldName,
                           String afterFieldName)

Moves the index field with the given fieldName after to the index field with the specified afterFieldName, shifting any existing elements after afterFieldName to the right.