org.symphonyoss.s2.canon.model

Class AbstractSchema

java.lang.Object

org.symphonyoss.s2.canon.model.ModelElement

org.symphonyoss.s2.canon.model.AbstractSchema

Direct Known Subclasses:

Field, ReferenceOrSchema

public abstract class AbstractSchema
extends ModelElement

An abstract Schema object, which could be an object, reference to an object, oneOf, allOf, or even a single field.

Author:

Bruce Skingle

Constructor Summary

Constructors

Constructor and Description
AbstractSchema(ModelElement parent, ParserContext context, String type, String name)

Method Summary

Modifier and Type	Method and Description
protected AbstractSchema	createSchema(ParserContext context)
protected void	generateChildren(GenerationContext generationContext, Map<String,Object> dataModel)
abstract Schema	getBaseSchema() Get the basic schema which this type refers to.
abstract Schema	getElementSchema() For an array type this is the schema of a single element of the array.
boolean	getIsAnonymousInnerClass()
abstract boolean	getIsArraySchema()
abstract boolean	getIsObjectSchema()
boolean	isRequired()
String	toString()
protected String	toString(List<?> children)
protected String	toString(StringBuffer details)
protected String	toString(ValueMap<String,Object> children)

Methods inherited from class org.symphonyoss.s2.canon.model.ModelElement

add, add, capitalize, generate, getAttributes, getByPath, getCamelCapitalizedName, getCamelName, getCanFailValidation, getChildren, getComponent, getContext, getDescription, getElementComponent, getElementType, getEnum, getFields, getFormat, getHasByteString, getHasCollections, getHasList, getHasSet, getIsComponent, getIsGenerateBuilderFacade, getIsGenerateFacade, getIsObjectType, getIsTypeDef, getModel, getName, getParent, getReference, getReferencedTypes, getReferencedTypes, getSchemas, getSchemas, getSnakeCapitalizedName, getSnakeName, getSummary, resolve, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSchema

public AbstractSchema(ModelElement parent,
                      ParserContext context,
                      String type,
                      String name)

Method Detail

generateChildren

protected void generateChildren(GenerationContext generationContext,
                                Map<String,Object> dataModel)
                         throws GenerationException

Overrides:

generateChildren in class ModelElement

Throws:

GenerationException

getBaseSchema

public abstract Schema getBaseSchema()

Get the basic schema which this type refers to. For a field it will be the field type, for a reference the referenced type. For a field whose type is a reference then it will be the ultimate referenced type. The baseSchema could be an ArraySchema

Overrides:

getBaseSchema in class ModelElement

Returns:

The base schema which this type refers to.

getElementSchema

public abstract Schema getElementSchema()

For an array type this is the schema of a single element of the array.

Overrides:

getElementSchema in class ModelElement

Returns:

The schema of a single element of an array

getIsArraySchema

public abstract boolean getIsArraySchema()

Overrides:

getIsArraySchema in class ModelElement

getIsObjectSchema

public abstract boolean getIsObjectSchema()

Overrides:

getIsObjectSchema in class ModelElement

isRequired

public boolean isRequired()

getIsAnonymousInnerClass

public boolean getIsAnonymousInnerClass()

createSchema

protected AbstractSchema createSchema(ParserContext context)

toString

public String toString()

Overrides:

toString in class ModelElement

toString

protected String toString(StringBuffer details)

toString

protected String toString(List<?> children)

toString

protected String toString(ValueMap<String,Object> children)