com.northconcepts.datapipeline.foundations.schema

Class IndexFieldDef

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.IndexFieldDef

All Implemented Interfaces:

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

public class IndexFieldDef
extends SchemaPart
implements Cloneable, SchemaProblemsSupplier, JavaCodeGenerator

The metadata model for a field in 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
IndexFieldDef()
IndexFieldDef(String fieldName)
IndexFieldDef(String fieldName, boolean ascending)

Method Summary

Modifier and Type	Method and Description
IndexFieldDef	assertValid()
IndexFieldDef	clone()
boolean	equals(Object obj)
IndexFieldDef	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
IndexFieldDef	fromXmlElement(Element fieldDefElement)
void	generateJavaCode(JavaCodeBuilder code)
String	getFieldName()
IndexDef	getIndexDef()
int	getIndexInIndexDef() Returns the zero-based index of this index field in IndexDef.
String	getIndexQualifiedName() Returns a qualified name that includes the name of this index field and the IndexDef above it separated by period.
String	getQualifiedName() Returns the fully qualified name that includes the name of this index field 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()
boolean	isAscending()
IndexFieldDef	setAscending(boolean ascending)
IndexFieldDef	setFieldName(String fieldName)
protected IndexFieldDef	setIndexDef(IndexDef indexDef)
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, 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

IndexFieldDef

public IndexFieldDef()

IndexFieldDef

public IndexFieldDef(String fieldName,
                     boolean ascending)

IndexFieldDef

public IndexFieldDef(String fieldName)

Method Detail

getSchemaProblems

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

Specified by:

getSchemaProblems in interface SchemaProblemsSupplier

generateJavaCode

public void generateJavaCode(JavaCodeBuilder code)

Specified by:

generateJavaCode in interface JavaCodeGenerator

clone

public IndexFieldDef clone()

Overrides:

clone in class FoundationObject

assertValid

public IndexFieldDef assertValid()

Overrides:

assertValid in class FoundationObject

getIndexDef

public IndexDef getIndexDef()

setIndexDef

protected IndexFieldDef setIndexDef(IndexDef indexDef)

getFieldName

public String getFieldName()

setFieldName

public IndexFieldDef setFieldName(String fieldName)

getQualifiedName

public String getQualifiedName()

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

getIndexQualifiedName

public String getIndexQualifiedName()

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

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

isAscending

public boolean isAscending()

setAscending

public IndexFieldDef setAscending(boolean ascending)

getIndexInIndexDef

public int getIndexInIndexDef()

Returns the zero-based index of this index field in IndexDef.

toJson

public String toJson()

Specified by:

toJson in interface JsonSerializable

Specified by:

toJson in interface RecordSerializable

toXmlElement

public Element toXmlElement(Document document)

Specified by:

toXmlElement in interface XmlSerializable

fromXmlElement

public IndexFieldDef fromXmlElement(Element fieldDefElement)

Specified by:

fromXmlElement in interface XmlSerializable

toRecord

public Record toRecord()

Specified by:

toRecord in interface RecordSerializable

Overrides:

toRecord in class Bean

fromRecord

public IndexFieldDef 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