org.opendaylight.yangtools.yang.model.util

Class AbstractSchemaContext

java.lang.Object

org.opendaylight.yangtools.yang.model.util.AbstractSchemaContext

All Implemented Interfaces:

ActionNodeContainer, AugmentationTarget, ContainerSchemaNode, DataNodeContainer, DataSchemaNode, DocumentedNode, DocumentedNode.WithStatus, NotificationNodeContainer, SchemaContext, SchemaNode

Direct Known Subclasses:

FilteringSchemaContextProxy, SimpleSchemaContext

public abstract class AbstractSchemaContext
extends Object
implements SchemaContext

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

DocumentedNode.WithStatus

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.google.common.base.Supplier<TreeSet<Module>>	MODULE_SET_SUPPLIER
protected static Comparator<Module>	REVISION_COMPARATOR

Fields inherited from interface org.opendaylight.yangtools.yang.model.api.SchemaContext

NAME

Constructor Summary

Constructors

Constructor and Description
AbstractSchemaContext()

Method Summary

Modifier and Type	Method and Description
Module	findModuleByName(String name, Date revision) Returns module instance (from the context) with concrete name and revision date.
Set<Module>	findModuleByNamespace(URI namespace) Returns module instance (from the context) with concrete namespace.
Set<ModuleIdentifier>	getAllModuleIdentifiers() Get all module and submodule identifiers.
Set<AugmentationSchema>	getAvailableAugmentations() Returns augmentations targeting this element.
Set<DataSchemaNode>	getChildNodes() Returns set of all child nodes defined within this DataNodeContainer.
ConstraintDefinition	getConstraints() Returns the constraints associated with Data Schema Node.
DataSchemaNode	getDataChildByName(QName name) Returns the child node corresponding to the specified name.
Set<DataSchemaNode>	getDataDefinitions() Returns data schema node instances which represents direct subnodes (like leaf, leaf-list, list, container) in all YANG modules in the context.
String	getDescription() All implementations should override this method.
Set<ExtensionDefinition>	getExtensions() Returns extencion definition instances which are defined as the direct subelements in all YANG modules in the context.
Set<GroupingDefinition>	getGroupings() Returns set of all groupings defined within this DataNodeContainer.
protected abstract Map<ModuleIdentifier,String>	getIdentifiersToSources() Returns the ModuleIdentifier-to-YANG source mapping.
com.google.common.base.Optional<String>	getModuleSource(ModuleIdentifier moduleIdentifier) Get yang source code represented as string for matching ModuleIdentifier.
protected abstract com.google.common.collect.SetMultimap<URI,Module>	getNamespaceToModules() Returns the namespace-to-module mapping.
protected abstract com.google.common.collect.SetMultimap<String,Module>	getNameToModules() Returns the module name-to-module mapping.
Set<NotificationDefinition>	getNotifications() All implementations should override this method.
Set<RpcDefinition>	getOperations() Returns rpc definition instances which are defined as the direct subelements in all YANG modules in the context.
SchemaPath	getPath() Returns the schema path of the instance of the type SchemaNode SchemaNode.
QName	getQName() Returns QName of the instance of the type SchemaNode.
String	getReference() All implementations should override this method.
Status	getStatus() Returns status of the instance of the type SchemaNode.
Set<TypeDefinition<?>>	getTypeDefinitions() Returns set of all newly defined types within this DataNodeContainer.
List<UnknownSchemaNode>	getUnknownSchemaNodes() Returns unknown schema nodes which belongs to this instance.
Set<UsesNode>	getUses() Returns grouping nodes used ny this container.
boolean	isAddedByUses() Returns true if the data node was added by uses statement, otherwise returns false.
boolean	isAugmenting() Returns true if the data node was added by augmentation, otherwise returns false.
boolean	isConfiguration() Returns true if the data represents configuration data, otherwise returns false.
boolean	isPresenceContainer() Returns true if this container is marked as presence.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.SchemaContext

findModuleByNamespaceAndRevision, getModules

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.ActionNodeContainer

getActions

Field Detail

REVISION_COMPARATOR

protected static final Comparator<Module> REVISION_COMPARATOR

MODULE_SET_SUPPLIER

protected static final com.google.common.base.Supplier<TreeSet<Module>> MODULE_SET_SUPPLIER

Constructor Detail

AbstractSchemaContext

public AbstractSchemaContext()

Method Detail

getIdentifiersToSources

protected abstract Map<ModuleIdentifier,String> getIdentifiersToSources()

Returns the ModuleIdentifier-to-YANG source mapping.

Returns:

yang sources where key is ModuleIdentifier

getNamespaceToModules

protected abstract com.google.common.collect.SetMultimap<URI,Module> getNamespaceToModules()

Returns the namespace-to-module mapping.

Returns:

Map of modules where key is namespace

getNameToModules

protected abstract com.google.common.collect.SetMultimap<String,Module> getNameToModules()

Returns the module name-to-module mapping.

Returns:

Map of modules where key is name of module

getDataDefinitions

public Set<DataSchemaNode> getDataDefinitions()

Description copied from interface: SchemaContext

Returns data schema node instances which represents direct subnodes (like leaf, leaf-list, list, container) in all YANG modules in the context.

Specified by:

getDataDefinitions in interface SchemaContext

Returns:

set of DataSchemaNode instances which represents YANG data nodes at the module top level

getNotifications

public Set<NotificationDefinition> getNotifications()

Description copied from interface: NotificationNodeContainer

All implementations should override this method. The default definition of this method is used in YANG 1.0 (RFC6020) implementations of AugmentationSchema, GroupingDefinition, ListSchemaNode and ContainerSchemaNode which do not allow notification statements. These YANG statements have been changed in YANG 1.1 (RFC7950) and can now contain notification statements.

The default definition is also used by implementations of ContainerSchemaNode which do not support notification statements such as InputEffectiveStatementImpl and OutputEffectiveStatementImpl.

Specified by:

getNotifications in interface NotificationNodeContainer

Returns:

set of notification nodes

getOperations

public Set<RpcDefinition> getOperations()

Description copied from interface: SchemaContext

Returns rpc definition instances which are defined as the direct subelements in all YANG modules in the context.

Specified by:

getOperations in interface SchemaContext

Returns:

set of RpcDefinition instances which represents nodes defined via rpc YANG keyword

getExtensions

public Set<ExtensionDefinition> getExtensions()

Description copied from interface: SchemaContext

Returns extencion definition instances which are defined as the direct subelements in all YANG modules in the context.

Specified by:

getExtensions in interface SchemaContext

Returns:

set of ExtensionDefinition instances which represents nodes defined via extension YANG keyword

findModuleByName

public Module findModuleByName(String name,
                               Date revision)

Description copied from interface: SchemaContext

Returns module instance (from the context) with concrete name and revision date.

Specified by:

findModuleByName in interface SchemaContext

Parameters:

name - string with the module name

revision - date of the module revision

Returns:

module instance which has name and revision (if specified) the same as are the values specified in parameters name and revision. In other cases the null value is returned.

findModuleByNamespace

public Set<Module> findModuleByNamespace(URI namespace)

Description copied from interface: SchemaContext

Returns module instance (from the context) with concrete namespace.

Specified by:

findModuleByNamespace in interface SchemaContext

Parameters:

namespace - URI instance with specified namespace

Returns:

module instance which has namespace equal to the namespace or null in other cases

isAugmenting

public boolean isAugmenting()

Description copied from interface: DataSchemaNode

Returns true if the data node was added by augmentation, otherwise returns false.

Specified by:

isAugmenting in interface DataSchemaNode

Returns:

true if the data node was added by augmentation, otherwise returns false

isAddedByUses

public boolean isAddedByUses()

Description copied from interface: DataSchemaNode

Returns true if the data node was added by uses statement, otherwise returns false.

Specified by:

isAddedByUses in interface DataSchemaNode

Returns:

true if the data node was added by uses statement, otherwise returns false

isConfiguration

public boolean isConfiguration()

Description copied from interface: DataSchemaNode

Returns true if the data represents configuration data, otherwise returns false.

Specified by:

isConfiguration in interface DataSchemaNode

Returns:

true if the data represents configuration data, otherwise returns false

getConstraints

public ConstraintDefinition getConstraints()

Description copied from interface: DataSchemaNode

Returns the constraints associated with Data Schema Node.

Specified by:

getConstraints in interface DataSchemaNode

Returns:

the constraints associated with Data Schema Node

getQName

@Nonnull
public QName getQName()

Description copied from interface: SchemaNode

Returns QName of the instance of the type SchemaNode.

Specified by:

getQName in interface SchemaNode

Returns:

QName with the name of the schema node

getPath

@Nonnull
public SchemaPath getPath()

Description copied from interface: SchemaNode

Returns the schema path of the instance of the type SchemaNode SchemaNode.

Specified by:

getPath in interface SchemaNode

Returns:

schema path of the schema node

getDescription

public String getDescription()

Description copied from interface: DocumentedNode

All implementations should override this method. The default definition of this method is used only in YANG 1.0 (RFC6020) implementations of ModuleImport which do not allow a description statement. YANG import statement has been changed in YANG 1.1 (RFC7950) and can now contain a description statement.

Specified by:

getDescription in interface DocumentedNode

Returns:

string that represents the argument of description statement

getReference

public String getReference()

Description copied from interface: DocumentedNode

All implementations should override this method. The default definition of this method is used only in YANG 1.0 (RFC6020) implementations of ModuleImport which do not allow a reference statement. YANG import statement has been changed in YANG 1.1 (RFC7950) and can now contain a reference statement.

Specified by:

getReference in interface DocumentedNode

Returns:

string that represents the argument of reference statement

getStatus

@Nonnull
public Status getStatus()

Description copied from interface: DocumentedNode.WithStatus

Returns status of the instance of the type SchemaNode.

Specified by:

getStatus in interface DocumentedNode.WithStatus

Returns:

status of this node which represents the argument of the YANG status substatement

getUnknownSchemaNodes

@Nonnull
public List<UnknownSchemaNode> getUnknownSchemaNodes()

Description copied from interface: DocumentedNode

Returns unknown schema nodes which belongs to this instance.

Specified by:

getUnknownSchemaNodes in interface DocumentedNode

Returns:

list of unknown schema nodes defined under this node.

getTypeDefinitions

public Set<TypeDefinition<?>> getTypeDefinitions()

Description copied from interface: DataNodeContainer

Returns set of all newly defined types within this DataNodeContainer.

Specified by:

getTypeDefinitions in interface DataNodeContainer

Returns:

typedef statements in lexicographical order

getChildNodes

public Set<DataSchemaNode> getChildNodes()

Description copied from interface: DataNodeContainer

Returns set of all child nodes defined within this DataNodeContainer. Although the return type is a collection, each node is guaranteed to be present at most once.

Specified by:

getChildNodes in interface DataNodeContainer

Returns:

child nodes in lexicographical order

getGroupings

public Set<GroupingDefinition> getGroupings()

Description copied from interface: DataNodeContainer

Returns set of all groupings defined within this DataNodeContainer.

Specified by:

getGroupings in interface DataNodeContainer

Returns:

grouping statements in lexicographical order

getDataChildByName

public DataSchemaNode getDataChildByName(QName name)

Description copied from interface: DataNodeContainer

Returns the child node corresponding to the specified name.

Specified by:

getDataChildByName in interface DataNodeContainer

Parameters:

name - QName of child

Returns:

child node of this DataNodeContainer if child with given name is present, null otherwise

getUses

public Set<UsesNode> getUses()

Description copied from interface: DataNodeContainer

Returns grouping nodes used ny this container.

Specified by:

getUses in interface DataNodeContainer

Returns:

Set of all uses nodes defined within this DataNodeContainer

isPresenceContainer

public boolean isPresenceContainer()

Description copied from interface: ContainerSchemaNode

Returns true if this container is marked as presence.

Specified by:

isPresenceContainer in interface ContainerSchemaNode

Returns:

true, if presence of this container has an explicit meaning, false otherwise

getAvailableAugmentations

public Set<AugmentationSchema> getAvailableAugmentations()

Description copied from interface: AugmentationTarget

Returns augmentations targeting this element.

Specified by:

getAvailableAugmentations in interface AugmentationTarget

Returns:

set of augmentations targeting this element.

getAllModuleIdentifiers

public Set<ModuleIdentifier> getAllModuleIdentifiers()

Description copied from interface: SchemaContext

Get all module and submodule identifiers.

Specified by:

getAllModuleIdentifiers in interface SchemaContext

getModuleSource

public com.google.common.base.Optional<String> getModuleSource(ModuleIdentifier moduleIdentifier)

Description copied from interface: SchemaContext

Get yang source code represented as string for matching ModuleIdentifier.

Specified by:

getModuleSource in interface SchemaContext

Parameters:

moduleIdentifier - must provide a non-null ModuleIdentifier.getName(), other methods might return null.

Returns:

value iif matching module is found in schema context.