|
Oracle Application Server DMS API Reference 10g Release 2 (10.1.2) B14002-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.dms.instrument.Noun
Noun
objects are used to organize the DMS name hierarchy. Nouns may contain Sensors or other Nouns. Generally, Nouns correspond program objects that are to be measured. By convention, Noun names start with a capital letter to distinguish them from Sensors. Character '/' is the default delimiter between Noun names. It is not recommanded that '/' is used as a part of the Noun name.
A Noun type is a name that reflects the set of metrics being collected. By convention, Noun type names are prefixed with the component name followed by an underscore. It is recommended that Nouns of the same type should have the same set of the metrics.
Field Summary | |
static java.lang.String |
UNKNOWN_TYPE The default Noun type. |
Method Summary | |
static Noun |
create(Noun parent, java.lang.String name, java.lang.String type) Creates a new Noun given a Noun parent, and a basename for the new Noun (not a pathname) |
static Noun |
create(java.lang.String pathname, java.lang.String type) Creates a new Noun given a pathname. |
void |
destroy() Destroys the Noun and all of its descendants. |
static Noun |
get(java.lang.String pathname) Returns a Noun given the Noun's pathname |
static Noun |
getRoot() Returns the root Noun for this JVM |
java.lang.String |
getType() Returns the type of a Noun as a String. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String UNKNOWN_TYPE
Method Detail |
public static Noun create(java.lang.String pathname, java.lang.String type)
pathname
- the pathname of the Nountype
- name of type for the Nounpublic static Noun create(Noun parent, java.lang.String name, java.lang.String type)
parent
- the Noun's parentname
- the Noun's short basename (not a pathname).type
- the Noun's typepublic java.lang.String getType()
UNKNOWN_TYPE
if the type was not explicitly set.public static Noun get(java.lang.String pathname)
pathname
- the pathname of the in the form <delim>name<delim>name... examples: /Wisconsin/Green/Monroe.Oregon.Multnomah.Portland etc.null
if the Noun cannot be found.public static Noun getRoot()
public void destroy()
|
Oracle Application Server DMS API Reference 10g Release 2 (10.1.2) B14002-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |