Module gov.nist.secauto.metaschema.core

Package gov.nist.secauto.metaschema.core.model

Interface IAssemblyDefinition

All Superinterfaces:

IAssembly, IConstrained, IContainer, IDefinition, gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureModelConstrained, gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureValueConstrained, IFlagContainer, IModelConstrained, IModelContainer, IModelElement, INamedModelElement, IValueConstrained

public interface IAssemblyDefinition
extends IFlagContainer, IModelContainer, IAssembly, gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureModelConstrained

Field Summary

Fields inherited from interface gov.nist.secauto.metaschema.core.model.IDefinition

DEFAULT_DEFINITION_MODEL_SCOPE

Method Summary

Modifier and Type	Method	Description
IAssemblyInstance	getInlineInstance()	If IDefinition.isInline() is true, return the instance the definition is inlined for.
default IAssemblyDefinition	getOwningDefinition()	Retrieve the Metaschema definition containing this container.
default String	getRootJsonName()	Get the name used for the associated property in JSON/YAML.
String	getRootName()	Get the root name if this assembly is a top-level root.
default QName	getRootXmlQName()	Get the XML qualified name to use in XML as the root element.
boolean	isRoot()	Check if the assembly is a top-level root assembly.
default boolean	isSimple()	Identifies if the field has flags or not, or if it has a complex structure (i.e, model).

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IAssembly

getModelType

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IDefinition

getModuleScope, isInline, toCoordinates

Methods inherited from interface gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureModelConstrained

addConstraint, addConstraint, addConstraint, getConstraintSupport, getHasCardinalityConstraints, getIndexConstraints, getUniqueConstraints

Methods inherited from interface gov.nist.secauto.metaschema.core.model.constraint.impl.IFeatureValueConstrained

addConstraint, addConstraint, addConstraint, addConstraint, getAllowedValuesConstraints, getConstraints, getExpectConstraints, getIndexHasKeyConstraints, getMatchesConstraints

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IFlagContainer

getFlagInstanceByName, getFlagInstances, getJsonKeyFlagInstance, hasJsonKey

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IModelContainer

getAssemblyInstanceByName, getAssemblyInstances, getChoiceInstances, getFieldInstanceByName, getFieldInstances, getModelInstanceByName, getModelInstances, getNamedModelInstances

Methods inherited from interface gov.nist.secauto.metaschema.core.model.IModelElement

getContainingModule, getRemarks

Methods inherited from interface gov.nist.secauto.metaschema.core.model.INamedModelElement

getDescription, getEffectiveDescription, getEffectiveFormalName, getEffectiveName, getFormalName, getJsonName, getName, getProperties, getPropertyValues, getUseName, hasProperty, hasPropertyValue

Method Detail

isRoot

boolean isRoot()

Check if the assembly is a top-level root assembly.

Returns:

true if the assembly is a top-level root, or false otherwise

getRootName

String getRootName()

Get the root name if this assembly is a top-level root.

Returns:

the root name if this assembly is a top-level root, or null otherwise

getRootXmlQName

default QName getRootXmlQName()

Get the XML qualified name to use in XML as the root element.

Returns:

the root XML qualified name if this assembly is a top-level root, or null otherwise

getRootJsonName

default String getRootJsonName()

Get the name used for the associated property in JSON/YAML.

Returns:

the root JSON property name if this assembly is a top-level root, or null otherwise

getInlineInstance

IAssemblyInstance getInlineInstance()

Description copied from interface: IDefinition

If IDefinition.isInline() is true, return the instance the definition is inlined for.

Specified by:

getInlineInstance in interface IDefinition

Specified by:

getInlineInstance in interface IFlagContainer

Returns:

the instance or null otherwise

getOwningDefinition

default IAssemblyDefinition getOwningDefinition()

Description copied from interface: IFlagContainer

Retrieve the Metaschema definition containing this container.

Specified by:

getOwningDefinition in interface IContainer

Specified by:

getOwningDefinition in interface IFlagContainer

Specified by:

getOwningDefinition in interface IModelContainer

Returns:

the containing Metaschema definition

isSimple

default boolean isSimple()

Description copied from interface: IFlagContainer

Identifies if the field has flags or not, or if it has a complex structure (i.e, model).

Specified by:

isSimple in interface IFlagContainer

Returns:

true if the field has no flags or model, or false otherwise