com.northconcepts.datapipeline.foundations.schema

Class EntityRelationshipDef

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

All Implemented Interfaces:

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

public class EntityRelationshipDef
extends SchemaPart
implements Cloneable, SchemaProblemsSupplier

The metadata model for relating two entities in a schema.

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
EntityRelationshipDef()
EntityRelationshipDef(String name)

Method Summary

Modifier and Type	Method and Description
EntityRelationshipDef	addForeignKeyFieldNames(String foreignKeyFieldName)
EntityRelationshipDef	clone()
boolean	containsForeignKeyFieldName(String name)
boolean	equals(Object obj)
EntityRelationshipDef	fromRecord(Record source) Loads this instance's state from a record and returns this (for fluid API call chaining).
EntityRelationshipDef	fromXmlElement(Element entityRelationShipDefElement)
void	generateJavaCode(JavaCodeBuilder code)
Attributes	getAttributes() User-defined key-value pairs to attached arbitrary metadata to this entityRelationShip.
RelationshipCardinality	getCardinality()
String	getDescription()
EntityDef	getForeignEntity()
String	getForeignEntityName()
List<String>	getForeignKeyFieldNames()
List<String>	getForeignKeyFieldNames(boolean create)
List<FieldDef>	getForeignKeyFields()
String	getName()
ForeignKeyAction	getOnDeleteAction()
ForeignKeyAction	getOnUpdateAction()
EntityDef	getPrimaryEntity()
String	getPrimaryEntityName()
List<FieldDef>	getPrimaryKeyFields()
String	getQualifiedName() Returns the fully qualified name that includes the name of this entity relationship and all names in its hierarchy separated by period.
SchemaDef	getSchemaDef()
SchemaPart	getSchemaPartContainer()
String	getSchemaPartName()
SchemaPartType	getSchemaPartType()
void	getSchemaProblems(List<SchemaProblem> problems, boolean includeChildren)
Tags	getTags() The set of labels used to organize, filter, and classify this entityRelationShip.
int	hashCode()
int	indexOfForeignKeyFieldName(String name)
EntityRelationshipDef	setAttributes(Attributes attributes)
EntityRelationshipDef	setCardinality(RelationshipCardinality cardinality)
EntityRelationshipDef	setDescription(String description)
EntityRelationshipDef	setForeignEntityName(String foreignEntityName)
EntityRelationshipDef	setForeignKeyFieldNames(List<String> foreignKeyFieldNames)
EntityRelationshipDef	setForeignKeyFieldNames(String... foreignKeyFieldNames)
EntityRelationshipDef	setName(String name)
EntityRelationshipDef	setOnDeleteAction(ForeignKeyAction onDeleteAction)
EntityRelationshipDef	setOnUpdateAction(ForeignKeyAction onUpdateAction)
EntityRelationshipDef	setPrimaryEntityName(String primaryEntityName)
protected EntityRelationshipDef	setSchemaDef(SchemaDef schemaDef)
EntityRelationshipDef	setTags(Tags tags)
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, 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

EntityRelationshipDef

public EntityRelationshipDef()

EntityRelationshipDef

public EntityRelationshipDef(String name)

Method Detail

getSchemaProblems

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

Specified by:

getSchemaProblems in interface SchemaProblemsSupplier

clone

public EntityRelationshipDef clone()

Overrides:

clone in class FoundationObject

generateJavaCode

public void generateJavaCode(JavaCodeBuilder code)

Specified by:

generateJavaCode in interface JavaCodeGenerator

getSchemaDef

public SchemaDef getSchemaDef()

Specified by:

getSchemaDef in class SchemaPart

setSchemaDef

protected EntityRelationshipDef setSchemaDef(SchemaDef schemaDef)

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

getName

public String getName()

setName

public EntityRelationshipDef setName(String name)

getQualifiedName

public String getQualifiedName()

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

getDescription

public String getDescription()

setDescription

public EntityRelationshipDef setDescription(String description)

getCardinality

public RelationshipCardinality getCardinality()

setCardinality

public EntityRelationshipDef setCardinality(RelationshipCardinality cardinality)

getPrimaryEntityName

public String getPrimaryEntityName()

setPrimaryEntityName

public EntityRelationshipDef setPrimaryEntityName(String primaryEntityName)

getPrimaryEntity

public EntityDef getPrimaryEntity()

getForeignEntityName

public String getForeignEntityName()

setForeignEntityName

public EntityRelationshipDef setForeignEntityName(String foreignEntityName)

getForeignEntity

public EntityDef getForeignEntity()

containsForeignKeyFieldName

public boolean containsForeignKeyFieldName(String name)

getForeignKeyFieldNames

public List<String> getForeignKeyFieldNames(boolean create)

getForeignKeyFieldNames

public List<String> getForeignKeyFieldNames()

getForeignKeyFields

public List<FieldDef> getForeignKeyFields()

setForeignKeyFieldNames

public EntityRelationshipDef setForeignKeyFieldNames(List<String> foreignKeyFieldNames)

setForeignKeyFieldNames

public EntityRelationshipDef setForeignKeyFieldNames(String... foreignKeyFieldNames)

addForeignKeyFieldNames

public EntityRelationshipDef addForeignKeyFieldNames(String foreignKeyFieldName)

getPrimaryKeyFields

public List<FieldDef> getPrimaryKeyFields()

getOnUpdateAction

public ForeignKeyAction getOnUpdateAction()

setOnUpdateAction

public EntityRelationshipDef setOnUpdateAction(ForeignKeyAction onUpdateAction)

getOnDeleteAction

public ForeignKeyAction getOnDeleteAction()

setOnDeleteAction

public EntityRelationshipDef setOnDeleteAction(ForeignKeyAction onDeleteAction)

indexOfForeignKeyFieldName

public int indexOfForeignKeyFieldName(String name)

getAttributes

public Attributes getAttributes()

User-defined key-value pairs to attached arbitrary metadata to this entityRelationShip.

setAttributes

public EntityRelationshipDef setAttributes(Attributes attributes)

getTags

public Tags getTags()

The set of labels used to organize, filter, and classify this entityRelationShip.

setTags

public EntityRelationshipDef setTags(Tags tags)

toXmlElement

public Element toXmlElement(Document document)

Specified by:

toXmlElement in interface XmlSerializable

fromXmlElement

public EntityRelationshipDef fromXmlElement(Element entityRelationShipDefElement)

Specified by:

fromXmlElement in interface XmlSerializable

toRecord

public Record toRecord()

Specified by:

toRecord in interface RecordSerializable

Overrides:

toRecord in class Bean

fromRecord

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