Module org.opendaylight.yangtools.yang.model.spi

Package org.opendaylight.yangtools.yang.model.spi

Class AbstractSchemaContext

java.lang.Object

org.opendaylight.yangtools.yang.model.spi.AbstractSchemaContext

All Implemented Interfaces:

Immutable, ActionNodeContainer, AddedByUsesAware, AugmentationTarget, ContainerLike, CopyableNode, DataNodeContainer, DataSchemaNode, DocumentedNode, DocumentedNode.WithStatus, MustConstraintAware, NotificationNodeContainer, SchemaContext, SchemaNode, WhenConditionAware

Direct Known Subclasses:

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	Description
static final Comparator<Module>	NAME_REVISION_COMPARATOR	A Module comparator based on ModuleLike.getName() and QNameModuleAware.getRevision(), ordering modules lexicographically by their name and then in order of descending revision.
static final Comparator<Module>	REVISION_COMPARATOR	A Module comparator based on QNameModuleAware.getRevision(), placing latest revision first.

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

NAME

Constructor Summary

Constructors

Constructor	Description
AbstractSchemaContext()

Method Summary

Modifier and Type	Method	Description
protected static final TreeSet<Module>	createModuleSet()	Create a TreeSet for containing Modules with the same name, such that the set is ordered by REVISION_COMPARATOR.
DataSchemaNode	dataChildByName(QName name)
Optional<? extends Module>	findModule(String name, Optional<Revision> revision)
Optional<Module>	findModule(QNameModule qnameModule)
Collection<? extends Module>	findModules(String name)
Collection<? extends Module>	findModules(XMLNamespace namespace)
Collection<? extends DataSchemaNode>	getChildNodes()
Collection<? extends DataSchemaNode>	getDataDefinitions()
Collection<? extends IdentitySchemaNode>	getDerivedIdentities(IdentitySchemaNode identity)
Collection<? extends ExtensionDefinition>	getExtensions()
Collection<? extends GroupingDefinition>	getGroupings()
protected abstract Map<QNameModule,Module>	getModuleMap()	Returns the namespace+revision-to-module mapping.
protected abstract com.google.common.collect.SetMultimap<XMLNamespace,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.
Collection<? extends NotificationDefinition>	getNotifications()
Collection<? extends RpcDefinition>	getOperations()
Collection<? extends TypeDefinition<?>>	getTypeDefinitions()
Collection<? extends UnknownSchemaNode>	getUnknownSchemaNodes()

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

findDataChildByName, findDataChildByName, findDataTreeChild, findDataTreeChild, getDataChildByName

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

isConfiguration

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

effectiveConfig, findAction, findDataTreeChild, findModule, findModule, findModule, findModule, findModule, findNotification, getActions, getAvailableAugmentations, getDescription, getModules, getMustConstraints, getQName, getReference, getStatus, getUses, getWhenCondition, isAddedByUses, isAugmenting

Field Details

REVISION_COMPARATOR

public static final Comparator<Module> REVISION_COMPARATOR

A Module comparator based on QNameModuleAware.getRevision(), placing latest revision first. Note this comparator does not take into account module name and so two modules with different names but same revisions compare as equal.

NAME_REVISION_COMPARATOR

public static final Comparator<Module> NAME_REVISION_COMPARATOR

A Module comparator based on ModuleLike.getName() and QNameModuleAware.getRevision(), ordering modules lexicographically by their name and then in order of descending revision. This comparator assumes that the combination of these two attributes is sufficient to be consistent with hashCode/equals.

Constructor Details

AbstractSchemaContext

public AbstractSchemaContext()

Method Details

createModuleSet

protected static final TreeSet<Module> createModuleSet()

Create a TreeSet for containing Modules with the same name, such that the set is ordered by REVISION_COMPARATOR.

Returns:

A fresh TreeSet instance.

getNamespaceToModules

protected abstract com.google.common.collect.SetMultimap<XMLNamespace,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

getModuleMap

protected abstract Map<QNameModule,Module> getModuleMap()

Returns the namespace+revision-to-module mapping.

Returns:

Map of modules where key is Module's QNameModule.

getDataDefinitions

public Collection<? extends DataSchemaNode> getDataDefinitions()

Specified by:

getDataDefinitions in interface SchemaContext

getNotifications

public Collection<? extends NotificationDefinition> getNotifications()

Specified by:

getNotifications in interface NotificationNodeContainer

getOperations

public Collection<? extends RpcDefinition> getOperations()

Specified by:

getOperations in interface SchemaContext

getExtensions

public Collection<? extends ExtensionDefinition> getExtensions()

Specified by:

getExtensions in interface SchemaContext

findModule

public Optional<? extends Module> findModule(String name,
 Optional<Revision> revision)

Specified by:

findModule in interface SchemaContext

findModule

public Optional<Module> findModule(QNameModule qnameModule)

Specified by:

findModule in interface SchemaContext

findModules

public Collection<? extends Module> findModules(XMLNamespace namespace)

Specified by:

findModules in interface SchemaContext

findModules

public Collection<? extends Module> findModules(String name)

Specified by:

findModules in interface SchemaContext

getUnknownSchemaNodes

public Collection<? extends UnknownSchemaNode> getUnknownSchemaNodes()

Specified by:

getUnknownSchemaNodes in interface DocumentedNode

getTypeDefinitions

public Collection<? extends TypeDefinition<?>> getTypeDefinitions()

Specified by:

getTypeDefinitions in interface DataNodeContainer

getChildNodes

public Collection<? extends DataSchemaNode> getChildNodes()

Specified by:

getChildNodes in interface DataNodeContainer

getGroupings

public Collection<? extends GroupingDefinition> getGroupings()

Specified by:

getGroupings in interface DataNodeContainer

dataChildByName

public DataSchemaNode dataChildByName(QName name)

Specified by:

dataChildByName in interface DataNodeContainer

getDerivedIdentities

public Collection<? extends IdentitySchemaNode> getDerivedIdentities(IdentitySchemaNode identity)

Specified by:

getDerivedIdentities in interface SchemaContext