org.onosproject.yang.runtime.impl

Class DefaultYangModelRegistry

java.lang.Object

org.onosproject.yang.runtime.impl.DefaultYangModelRegistry

All Implemented Interfaces:

org.onosproject.yang.model.SchemaContext, org.onosproject.yang.model.SingleInstanceNodeContext, YangModelRegistry

public class DefaultYangModelRegistry
extends Object
implements YangModelRegistry, org.onosproject.yang.model.SingleInstanceNodeContext

Represents YANG model registry implementation.

Constructor Summary

Constructors

Constructor and Description
DefaultYangModelRegistry() Creates an instance of default YANG schema registry.

Method Summary

Modifier and Type	Method and Description
org.onosproject.yang.model.SchemaContext	getChildContext(org.onosproject.yang.model.SchemaId schemaId)
org.onosproject.yang.compiler.datamodel.YangSchemaNode	getForNameSpace(String nameSpace, boolean isForChildContext) Returns schema node for the given name.
org.onosproject.yang.compiler.datamodel.YangSchemaNode	getForSchemaName(String schemaName) Returns schema node for the given name.
org.onosproject.yang.model.YangModel	getModel(String id) Returns YANG model for given model id.
Set<org.onosproject.yang.model.YangModel>	getModels() Returns collection of all registered models.
org.onosproject.yang.model.YangModule	getModule(org.onosproject.yang.model.YangModuleId id) Returns YANG module for given YANG module id.
org.onosproject.yang.model.SchemaContext	getParentContext()
org.onosproject.yang.model.SchemaId	getSchemaId()
org.onosproject.yang.model.DataNode.Type	getType()
void	registerAnydataSchema(org.onosproject.yang.model.ModelObjectId aid, org.onosproject.yang.model.ModelObjectId cid) Registers the given generated node referenced by given model object identifier under provided anydata model object identifier.
void	registerModel(ModelRegistrationParam param) Registers a new model.
void	unregisterAnydataSchema(Class id, Class id1) Unregisters the given generated node class under provided anydata class.
void	unregisterModel(ModelRegistrationParam param) Unregisters the specified model.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultYangModelRegistry

public DefaultYangModelRegistry()

Creates an instance of default YANG schema registry.

Method Detail

registerModel

public void registerModel(ModelRegistrationParam param)
                   throws IllegalArgumentException

Description copied from interface: YangModelRegistry

Registers a new model.

Specified by:

registerModel in interface YangModelRegistry

Parameters:

param - parameters having model to be registered with additional information provided by app

Throws:

IllegalArgumentException - when requested model with provided identifier is already registered or not valid

registerAnydataSchema

public void registerAnydataSchema(org.onosproject.yang.model.ModelObjectId aid,
                                  org.onosproject.yang.model.ModelObjectId cid)
                           throws IllegalArgumentException

Description copied from interface: YangModelRegistry

Registers the given generated node referenced by given model object identifier under provided anydata model object identifier.

Specified by:

registerAnydataSchema in interface YangModelRegistry

Parameters:

aid - identifier to reference anydata container under which application is expecting the data

cid - identifier to reference the node defined in YANG file which application can send as content or child nodes under anydata

Throws:

IllegalArgumentException - when provided identifier is not not valid

unregisterAnydataSchema

public void unregisterAnydataSchema(Class id,
                                    Class id1)
                             throws IllegalArgumentException

Description copied from interface: YangModelRegistry

Unregisters the given generated node class under provided anydata class.

Specified by:

unregisterAnydataSchema in interface YangModelRegistry

Parameters:

id - identifier to reference anydata container under which application has registered the schema

id1 - identifier to reference the node defined in YANG file which application can send as content or child nodes under anydata

Throws:

IllegalArgumentException - when provided identifier is not not valid

unregisterModel

public void unregisterModel(ModelRegistrationParam param)

Description copied from interface: YangModelRegistry

Unregisters the specified model.

Specified by:

unregisterModel in interface YangModelRegistry

Parameters:

param - parameters having model to be registered with additional information provided by app

getModels

public Set<org.onosproject.yang.model.YangModel> getModels()

Description copied from interface: YangModelRegistry

Returns collection of all registered models.

Specified by:

getModels in interface YangModelRegistry

Returns:

collection of models

getForSchemaName

public org.onosproject.yang.compiler.datamodel.YangSchemaNode getForSchemaName(String schemaName)

Returns schema node for the given name. Name should be schema defined name.

Parameters:

schemaName - schema name

Returns:

YANG schema node

getModel

public org.onosproject.yang.model.YangModel getModel(String id)

Description copied from interface: YangModelRegistry

Returns YANG model for given model id.

Specified by:

getModel in interface YangModelRegistry

Parameters:

id - model identifier

Returns:

YANG model

getModule

public org.onosproject.yang.model.YangModule getModule(org.onosproject.yang.model.YangModuleId id)

Description copied from interface: YangModelRegistry

Returns YANG module for given YANG module id.

Specified by:

getModule in interface YangModelRegistry

Parameters:

id - module identifier

Returns:

YANG module

getForNameSpace

public org.onosproject.yang.compiler.datamodel.YangSchemaNode getForNameSpace(String nameSpace,
                                                                              boolean isForChildContext)

Returns schema node for the given name. Name should be nodes namespace defined in YANG file

Parameters:

nameSpace - name space of YANG file

isForChildContext - if the method call has arrived for child context

Returns:

YANG schema node

getParentContext

public org.onosproject.yang.model.SchemaContext getParentContext()

Specified by:

getParentContext in interface org.onosproject.yang.model.SchemaContext

getType

public org.onosproject.yang.model.DataNode.Type getType()

Specified by:

getType in interface org.onosproject.yang.model.SchemaContext

getSchemaId

public org.onosproject.yang.model.SchemaId getSchemaId()

Specified by:

getSchemaId in interface org.onosproject.yang.model.SchemaContext

getChildContext

public org.onosproject.yang.model.SchemaContext getChildContext(org.onosproject.yang.model.SchemaId schemaId)

Specified by:

getChildContext in interface org.onosproject.yang.model.SingleInstanceNodeContext