com.northconcepts.datapipeline.foundations.schema

Class SchemaDef

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

All Implemented Interfaces:

JsonSerializable, RecordSerializable, XmlSerializable, Serializable

public class SchemaDef
extends SchemaObject

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)

Method Summary

Modifier and Type	Method and Description
SchemaDef	addEntity(EntityDef entity)
boolean	containsEntity(String name)
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)
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)
EntityDef	getEntity(String name)
String	getName() The human-readable text identifier for this schema.
Tags	getTags() The set of labels used to organize, filter, and classify this schema.
int	indexOfEntity(String name)
SchemaDef	setAttributes(Attributes attributes)
SchemaDef	setDescription(String description)
SchemaDef	setEntities(List<EntityDef> entities)
SchemaDef	setName(String name)
SchemaDef	setTags(Tags tags)
Record	toRecord()
Element	toXmlElement(Document document)

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

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

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

toString

Methods inherited from class java.lang.Object

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

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

fromArrayValue, fromArrayValue, fromArrayValue, 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

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

Constructor Detail

SchemaDef

public SchemaDef()

SchemaDef

public SchemaDef(String name)

Method Detail

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)

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)

containsEntity

public boolean containsEntity(String name)

getEntity

public EntityDef getEntity(String name)

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)

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)

fromJson

public SchemaDef fromJson(InputStream inputStream)

fromXml

public SchemaDef fromXml(InputStream inputStream)

fromXml

public SchemaDef fromXml(String xml)

toXmlElement

public Element toXmlElement(Document document)

fromXmlElement

public SchemaDef fromXmlElement(Element schemaElement)