SchemaDef (Data Pipeline JavaDoc)

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

All Implemented Interfaces:

DataExceptionContributor, JsonSerializable, RecordSerializable, XmlSerializable, SchemaProblemsSupplier, JavaCodeGenerator, Serializable, Cloneable
```
public class SchemaDef
extends SchemaPart
implements Cloneable, SchemaProblemsSupplier
```
The metadata model containing a set of related entities.

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

SchemaDef()

SchemaDef(String name)

Constructors
Constructor and Description
`SchemaDef()`
`SchemaDef(String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SchemaDef`	`addEntity(EntityDef entity)`
`SchemaDef`	`addEntityRelationship(EntityRelationshipDef entityRelationship)`
`SchemaDef`	`clone()`
`boolean`	`containsEntity(String name)` Returns true if this schema contains an `EntityDef` with the specified `name`.
`boolean`	`containsEntityRelationship(String name)` Returns true if this schema contains an `EntityRelationshipDef` with the specified `name`.
`boolean`	`equals(Object obj)`
`SchemaDef`	`fromJson(InputStream inputStream)`
`SchemaDef`	`fromJson(String jsonString)`
`SchemaDef`	`fromRecord(Record source)` Loads this instance's state from a record and returns `this` (for fluid API call chaining).
`SchemaDef`	`fromXml(InputStream inputStream)`
`SchemaDef`	`fromXml(String xml)`
`SchemaDef`	`fromXmlElement(Element schemaElement)`
`void`	`generateJavaCode(JavaCodeBuilder code)`
`Attributes`	`getAttributes()` User-defined key-value pairs to attached arbitrary metadata to this schema.
`String`	`getDescription()` The human-readable summary of this schema.
`List<EntityDef>`	`getEntities()`
`List<EntityDef>`	`getEntities(boolean create)`
`List<EntityDef>`	`getEntities(String name)`
`EntityDef`	`getEntity(String name)` Returns the `EntityDef` that matches the specified name.
`int`	`getEntityCount()`
`List<String>`	`getEntityNames()`
`EntityRelationshipDef`	`getEntityRelationship(String name)` Returns the `EntityRelationshipDef` that matches the specified name.
`EntityRelationshipDef`	`getEntityRelationshipByForeignKeyName(String foreignKeyName)`
`int`	`getEntityRelationshipCount()` Returns the number of entity relationships in this schema.
`List<String>`	`getEntityRelationshipNames()` Returns the names of all entity relationships in this schema.
`List<EntityRelationshipDef>`	`getEntityRelationships()`
`List<EntityRelationshipDef>`	`getEntityRelationships(boolean create)`
`List<EntityRelationshipDef>`	`getEntityRelationshipsByForeignKeyName(String foreignKeyName)`
`List<EntityRelationshipDef>`	`getForeignEntityRelationships(EntityDef foreignEntity)`
`String`	`getName()` The human-readable text identifier for this schema.
`List<EntityRelationshipDef>`	`getPrimaryEntityRelationships(EntityDef primaryEntity)`
`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 schema.
`int`	`hashCode()`
`int`	`indexOfEntity(String name)` Returns the zero-based position of the `EntityDef` with the specified name or -1 if it is not found.
`int`	`indexOfEntityRelationship(String name)` Returns the zero-based position of the `EntityRelationshipDef` with the specified name or -1 if it is not found.
`SchemaDef`	`setAttributes(Attributes attributes)`
`SchemaDef`	`setDescription(String description)`
`SchemaDef`	`setEntities(List<EntityDef> entities)`
`SchemaDef`	`setEntityRelationships(List<EntityRelationshipDef> entityRelationships)`
`SchemaDef`	`setName(String name)`
`SchemaDef`	`setTags(Tags tags)`
`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, 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, 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
  - SchemaDef
```
public SchemaDef()
```
  - SchemaDef
```
public SchemaDef(String name)
```
- Method Detail
  - getSchemaProblems
```
public void getSchemaProblems(List<SchemaProblem> problems,
                              boolean includeChildren)
```
    Specified by:
    
    getSchemaProblems in interface SchemaProblemsSupplier
  - clone
```
public SchemaDef 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
  - 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()
```
    The human-readable text identifier for this schema.
  - setName
```
public SchemaDef setName(String name)
```
  - getDescription
```
public String getDescription()
```
    The human-readable summary of this schema.
  - setDescription
```
public SchemaDef setDescription(String description)
```
  - getEntityCount
```
public int getEntityCount()
```
  - getEntityNames
```
public List<String> getEntityNames()
```
  - getEntities
```
public List<EntityDef> getEntities(boolean create)
```
  - getEntities
```
public List<EntityDef> getEntities()
```
  - setEntities
```
public SchemaDef setEntities(List<EntityDef> entities)
```
  - addEntity
```
public SchemaDef addEntity(EntityDef entity)
```
  - indexOfEntity
```
public int indexOfEntity(String name)
```
    Returns the zero-based position of the EntityDef with the specified name or -1 if it is not found.
  - containsEntity
```
public boolean containsEntity(String name)
```
    Returns true if this schema contains an EntityDef with the specified name.
  - getEntity
```
public EntityDef getEntity(String name)
```
    Returns the EntityDef that matches the specified name.
  - getEntities
```
public List<EntityDef> getEntities(String name)
```
  - indexOfEntityRelationship
```
public int indexOfEntityRelationship(String name)
```
    Returns the zero-based position of the EntityRelationshipDef with the specified name or -1 if it is not found.
  - containsEntityRelationship
```
public boolean containsEntityRelationship(String name)
```
    Returns true if this schema contains an EntityRelationshipDef with the specified name.
  - getEntityRelationshipCount
```
public int getEntityRelationshipCount()
```
    Returns the number of entity relationships in this schema.
  - getEntityRelationshipNames
```
public List<String> getEntityRelationshipNames()
```
    Returns the names of all entity relationships in this schema.
  - getEntityRelationships
```
public List<EntityRelationshipDef> getEntityRelationships(boolean create)
```
  - getEntityRelationship
```
public EntityRelationshipDef getEntityRelationship(String name)
```
    Returns the EntityRelationshipDef that matches the specified name.
  - getEntityRelationships
```
public List<EntityRelationshipDef> getEntityRelationships()
```
  - getEntityRelationshipByForeignKeyName
```
public EntityRelationshipDef getEntityRelationshipByForeignKeyName(String foreignKeyName)
```
  - getEntityRelationshipsByForeignKeyName
```
public List<EntityRelationshipDef> getEntityRelationshipsByForeignKeyName(String foreignKeyName)
```
  - setEntityRelationships
```
public SchemaDef setEntityRelationships(List<EntityRelationshipDef> entityRelationships)
```
  - addEntityRelationship
```
public SchemaDef addEntityRelationship(EntityRelationshipDef entityRelationship)
```
  - getPrimaryEntityRelationships
```
public List<EntityRelationshipDef> getPrimaryEntityRelationships(EntityDef primaryEntity)
```
  - getForeignEntityRelationships
```
public List<EntityRelationshipDef> getForeignEntityRelationships(EntityDef foreignEntity)
```
  - getAttributes
```
public Attributes getAttributes()
```
    User-defined key-value pairs to attached arbitrary metadata to this schema.
  - setAttributes
```
public SchemaDef setAttributes(Attributes attributes)
```
  - getTags
```
public Tags getTags()
```
    The set of labels used to organize, filter, and classify this schema.
  - setTags
```
public SchemaDef setTags(Tags tags)
```
  - 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 SchemaDef 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.
  - fromJson
```
public SchemaDef fromJson(String jsonString)
```
    Specified by:
    
    fromJson in interface JsonSerializable
    
    Specified by:
    
    fromJson in interface RecordSerializable
  - fromJson
```
public SchemaDef fromJson(InputStream inputStream)
```
    Specified by:
    
    fromJson in interface JsonSerializable
    
    Specified by:
    
    fromJson in interface RecordSerializable
  - fromXml
```
public SchemaDef fromXml(InputStream inputStream)
```
    Specified by:
    
    fromXml in interface XmlSerializable
  - fromXml
```
public SchemaDef fromXml(String xml)
```
    Specified by:
    
    fromXml in interface XmlSerializable
  - toXmlElement
```
public Element toXmlElement(Document document)
```
    Specified by:
    
    toXmlElement in interface XmlSerializable
  - fromXmlElement
```
public SchemaDef fromXmlElement(Element schemaElement)
```
    Specified by:
    
    fromXmlElement in interface XmlSerializable
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class SchemaDef

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

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

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

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

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

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

Constructor Detail

SchemaDef

SchemaDef

Method Detail

getSchemaProblems

clone

generateJavaCode

getSchemaDef

getSchemaPartContainer

getSchemaPartType

getSchemaPartName

getName

setName

getDescription

setDescription

getEntityCount

getEntityNames

getEntities

getEntities

setEntities

addEntity

indexOfEntity

containsEntity

getEntity

getEntities

indexOfEntityRelationship

containsEntityRelationship

getEntityRelationshipCount

getEntityRelationshipNames

getEntityRelationships

getEntityRelationship

getEntityRelationships

getEntityRelationshipByForeignKeyName

getEntityRelationshipsByForeignKeyName

setEntityRelationships

addEntityRelationship

getPrimaryEntityRelationships

getForeignEntityRelationships

getAttributes

setAttributes

getTags

setTags

toJson

toRecord

fromRecord

fromJson

fromJson

fromXml

fromXml

toXmlElement

fromXmlElement

hashCode

equals