Class EntityDescriber

java.lang.Object

org.tentackle.maven.plugin.mcp.render.EntityDescriber

public class EntityDescriber
extends Object

Describes one entity.

The primary representation is the canonical model definition: the densest, least ambiguous description of an entity that exists, and the language the caller has to write back. Everything the DSL cannot express because it is computed from the whole model graph is added as an explicit section.

Author:

harald

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	DEFAULT_SECTIONS	The sections rendered when the caller names none.
static final String[]	SECTIONS	The sections that can be rendered; in the order they are rendered.

Constructor Summary

Constructors

Constructor	Description
EntityDescriber(Entity entity, Scope scope, Collection<String> sections, ModelDefaults modelDefaults, Collection<org.tentackle.sql.Backend> backends)	Creates a describer.

Method Summary

Modifier and Type	Method	Description
String	describe()	Renders the description.

Methods inherited from class Object

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

Field Details

SECTIONS

public static final String[] SECTIONS

The sections that can be rendered; in the order they are rendered.

DEFAULT_SECTIONS

public static final List<String> DEFAULT_SECTIONS

The sections rendered when the caller names none.

Constructor Details

EntityDescriber

public EntityDescriber(Entity entity,
 Scope scope,
 Collection<String> sections,
 ModelDefaults modelDefaults,
 Collection<org.tentackle.sql.Backend> backends)

Creates a describer.

Parameters:

entity - the entity to describe

scope - the scope of the member sections

sections - the sections to render, see SECTIONS

modelDefaults - the model defaults, null if none

backends - the backends for the ddl section, empty if none configured

Method Details

describe

public String describe()
                throws ModelException

Renders the description.

Returns:

the description

Throws:

ModelException - if the model is inconsistent