net.mdatools.modelant.core.util

Class Navigator

java.lang.Object

net.mdatools.modelant.core.util.Navigator

public class Navigator
extends Object

Retrieve associated model elements, a single model element, or a single attribute value, starting from the current model being processed, down an explicit path provided.

Author:

Rusi Popov (popovr@mdatools.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_IMMEDIATE_PACKAGE An element of the object navigation path that leads to the obejct's immediate package
static String	NAME_METACLASSNAME An element of the object navigation path that leads to the qualified name of the obejct's meta-object within the MOF metamodel
static String	NAME_METAOBJECT An element of the object navigation path that leads to the obejct's meta-object
static String	NAME_MOFID The explicit attribute name that refers the MOF ID of the object.
static String	NAME_OUTER_MOST_PACKAGE An element of the object navigation path that leads to the obejct's outer-most package
static String	OBJECT_PATH_SEPARATORS Regular expression for allowed separators in object navigation paths

Constructor Summary

Constructors

Constructor and Description
Navigator()

Method Summary

Modifier and Type	Method and Description
static List<? extends Object>	collectValues(javax.jmi.reflect.RefFeatured startFrom, String path, boolean reportExceptions) Collects all values the path describes starting form the startFrom object
static List<javax.jmi.reflect.RefAssociation>	getAllAssociations(javax.jmi.reflect.RefPackage sourceExtent)
static List<javax.jmi.reflect.RefClass>	getAllClasses(javax.jmi.reflect.RefPackage sourceExtent) This method locates all objects in the model package/extent
static List<javax.jmi.reflect.RefObject>	getAllObjects(javax.jmi.reflect.RefPackage sourceExtent) This method locates all objects in the model package/extent
static Collection<javax.jmi.model.Classifier>	getAllSuperMetaObejcts(javax.jmi.model.Classifier mofMetaObject) This method retrieves the descriptions of all super classes in the metamodel
static javax.jmi.reflect.RefClass	getMetaClass(javax.jmi.reflect.RefPackage rootPackage, String metaClassName) This method parses the metaclass parameter, matches it with the meta model structure, and finds the meta class with the qualified metaclass name.
static String	getMetaClassName(javax.jmi.reflect.RefObject element) This method constructs the name of the metaclass of the model element provided.
static javax.jmi.reflect.RefPackage	getMetaPackage(javax.jmi.reflect.RefPackage rootPackage, String metaPackageName) This method finds the metapackage with the name provided
static Object	getReflectiveValue(Object startFrom, String itemName) Retrieve a single value using of the named association or attribute, using the MOF reflective interfaces

Methods inherited from class java.lang.Object

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

Field Detail

OBJECT_PATH_SEPARATORS

public static final String OBJECT_PATH_SEPARATORS

Regular expression for allowed separators in object navigation paths

See Also:

Constant Field Values

NAME_MOFID

public static final String NAME_MOFID

The explicit attribute name that refers the MOF ID of the object.

See Also:

Constant Field Values

NAME_METAOBJECT

public static final String NAME_METAOBJECT

An element of the object navigation path that leads to the obejct's meta-object

See Also:

Constant Field Values

NAME_METACLASSNAME

public static final String NAME_METACLASSNAME

An element of the object navigation path that leads to the qualified name of the obejct's meta-object within the MOF metamodel

See Also:

Constant Field Values

NAME_OUTER_MOST_PACKAGE

public static final String NAME_OUTER_MOST_PACKAGE

An element of the object navigation path that leads to the obejct's outer-most package

See Also:

Constant Field Values

NAME_IMMEDIATE_PACKAGE

public static final String NAME_IMMEDIATE_PACKAGE

An element of the object navigation path that leads to the obejct's immediate package

See Also:

Constant Field Values

Constructor Detail

Navigator

public Navigator()

Method Detail

collectValues

public static List<? extends Object> collectValues(javax.jmi.reflect.RefFeatured startFrom,
                                                   String path,
                                                   boolean reportExceptions)
                                            throws javax.jmi.reflect.JmiException

Collects all values the path describes starting form the startFrom object

 Format: {asssociationName.}[attributeName]

  associationName = name
                    | METAOBJECT
                    | METACLASSNAME
                    | IPACKAGE
                    | OPACKAGE

  attributeName = name
                  | MOFID
 where:
   MOFID refers the MOF ID of the object to process
   METAOBJECT retrieves the meta-object of the object to process. This allows reflective navigation.
   METACLASSNAME retrieves the qualified (in the meta-model) name of the meta-class for the processed object.
   IPACKAGE retrieves the immediate package in the meta-model the processed object is in
   OPACKAGE retrieves the outer-most package (the extent) where object processed is in

 

Parameters:

startFrom -

path - is a non-null path following *-to-many or *-to-one associations and ending optionally with attribute

reportExceptions - in some cases it makes no sense to report the exceptions, while generating them allocates significant resources, but the client code does not use them. Set it to true in order to suppress throwing the exceptions.

Returns:

a non-null collection of non-null and non-empty string values

Throws:

javax.jmi.reflect.JmiException

getReflectiveValue

public static Object getReflectiveValue(Object startFrom,
                                        String itemName)
                                 throws javax.jmi.reflect.InvalidNameException

Retrieve a single value using of the named association or attribute, using the MOF reflective interfaces

Parameters:

startFrom -

itemName -

Returns:

the retrieved value

Throws:

javax.jmi.reflect.InvalidNameException - when the value could not be retrieved

getAllObjects

public static List<javax.jmi.reflect.RefObject> getAllObjects(javax.jmi.reflect.RefPackage sourceExtent)

This method locates all objects in the model package/extent

Parameters:

sourceExtent - non-null extent where to find the metaclass

Returns:

an iterator on all objects in meta-classes in this or nested packages

getAllAssociations

public static List<javax.jmi.reflect.RefAssociation> getAllAssociations(javax.jmi.reflect.RefPackage sourceExtent)

Parameters:

sourceExtent - non-null extent where to find the metaclasses

Returns:

non-null list of all meta-classes in sourceExtent and its sub-packages

getAllClasses

public static List<javax.jmi.reflect.RefClass> getAllClasses(javax.jmi.reflect.RefPackage sourceExtent)

This method locates all objects in the model package/extent

Parameters:

sourceExtent - non-null extent where to find the metaclass

Returns:

an iterator on all objects in meta-classes in this or nested packages

getMetaPackage

public static javax.jmi.reflect.RefPackage getMetaPackage(javax.jmi.reflect.RefPackage rootPackage,
                                                          String metaPackageName)
                                                   throws javax.jmi.reflect.JmiException

This method finds the metapackage with the name provided

Parameters:

rootPackage - is the top-most package / the model's extent

metaPackageName - a meta package name with syntax [<package>{::<package>}]

Returns:

the non-null meta package

Throws:

javax.jmi.reflect.JmiException - if the meta package name is not a valid one

getMetaClass

public static javax.jmi.reflect.RefClass getMetaClass(javax.jmi.reflect.RefPackage rootPackage,
                                                      String metaClassName)
                                               throws javax.jmi.reflect.JmiException

This method parses the metaclass parameter, matches it with the meta model structure, and finds the meta class with the qualified metaclass name.

Parameters:

rootPackage - is the top-most package / the model's extent

metaClassName - a meta class qualified name with syntax {<package>::} <class>

Returns:

the non-null metaclass described in the metaclass attribute

Throws:

javax.jmi.reflect.JmiException - if the metaclass name is not a valid one

getMetaClassName

public static String getMetaClassName(javax.jmi.reflect.RefObject element)
                               throws javax.jmi.reflect.JmiException

This method constructs the name of the metaclass of the model element provided.

Parameters:

element - is the non-null object to find metaclass of

Returns:

the non-null metaclass name

Throws:

javax.jmi.reflect.JmiException - if the metaclass name is not a valid one

getAllSuperMetaObejcts

public static Collection<javax.jmi.model.Classifier> getAllSuperMetaObejcts(javax.jmi.model.Classifier mofMetaObject)

This method retrieves the descriptions of all super classes in the metamodel

Parameters:

mofMetaObject -

Returns:

a non-null unique collection of superclasses of the provided class from the metamodel