org.eclipse.hyades.logging.adapter.model.internal.context
Interface ContextType

All Superinterfaces:

org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

All Known Implementing Classes:

ContextTypeImpl

public interface ContextType
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'Type'. This type describes a context. A context contains a sequence of Component elements as well as its own definition. The purpose of a concrete context is to use a set of components to typically monitor a data source and produce Common Base Events. Logically a context can leverage any number of components and it is up to the context and it's contract with components as to how it uses the components. For example the basic context implementation provided in TPTP simply passes the results of one component to the next in the order they are declared in this document, and the first component is asserted to be a sensor.

The following features are supported:

• Group
• Component
• Description
• Executable Class
• Implementation Creation Date
• Implementation Version
• Implementation Version Description
• Logging Level
• Name
• Role
• Role Creation Date
• Role Version
• Role Version Description
• Unique ID

See Also:

ContextPackage.getContextType()

Generated

[EMF] Model

extendedMetaData="name='contextType' kind='elementOnly'"

Method Summary

org.eclipse.emf.common.util.EList	getComponent() Returns the value of the 'Component' containment reference list.
java.lang.String	getDescription() Returns the value of the 'Description' attribute
java.lang.String	getExecutableClass() Returns the value of the 'Executable Class' attribute
org.eclipse.emf.ecore.util.FeatureMap	getGroup() Returns the value of the 'Group' attribute list.
java.lang.Object	getImplementationCreationDate() Returns the value of the 'Implementation Creation Date' attribute
java.lang.String	getImplementationVersion() Returns the value of the 'Implementation Version' attribute
java.lang.String	getImplementationVersionDescription() Returns the value of the 'Implementation Version Description' attribute
java.lang.String	getLoggingLevel() Returns the value of the 'Logging Level' attribute
java.lang.String	getName() Returns the value of the 'Name' attribute
ContextRoleNames	getRole() Returns the value of the 'Role' attribute.
java.lang.Object	getRoleCreationDate() Returns the value of the 'Role Creation Date' attribute
java.lang.String	getRoleVersion() Returns the value of the 'Role Version' attribute
java.lang.String	getRoleVersionDescription() Returns the value of the 'Role Version Description' attribute
java.lang.String	getUniqueID() Returns the value of the 'Unique ID' attribute
boolean	isSetRole() Returns whether the value of the 'Role' attribute is set
void	setDescription(java.lang.String value) Sets the value of the 'Description' attribute
void	setExecutableClass(java.lang.String value) Sets the value of the 'Executable Class' attribute
void	setImplementationCreationDate(java.lang.Object value) Sets the value of the 'Implementation Creation Date' attribute
void	setImplementationVersion(java.lang.String value) Sets the value of the 'Implementation Version' attribute
void	setImplementationVersionDescription(java.lang.String value) Sets the value of the 'Implementation Version Description' attribute
void	setLoggingLevel(java.lang.String value) Sets the value of the 'Logging Level' attribute
void	setName(java.lang.String value) Sets the value of the 'Name' attribute
void	setRole(ContextRoleNames value) Sets the value of the 'Role' attribute
void	setRoleCreationDate(java.lang.Object value) Sets the value of the 'Role Creation Date' attribute
void	setRoleVersion(java.lang.String value) Sets the value of the 'Role Version' attribute
void	setRoleVersionDescription(java.lang.String value) Sets the value of the 'Role Version Description' attribute
void	setUniqueID(java.lang.String value) Sets the value of the 'Unique ID' attribute
void	unsetRole() Unsets the value of the 'Role' attribute

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

getGroup

org.eclipse.emf.ecore.util.FeatureMap getGroup()

Returns the value of the 'Group' attribute list. The list contents are of type FeatureMap.Entry.

If the meaning of the 'Group' attribute list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Group' attribute list.

See Also:

ContextPackage.getContextType_Group()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.EFeatureMapEntry" many="true" extendedMetaData="kind='group' name='group:0'"

getComponent

org.eclipse.emf.common.util.EList getComponent()

Returns the value of the 'Component' containment reference list. The list contents are of type Component.

If the meaning of the 'Component' containment reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Component' containment reference list.

See Also:

ContextPackage.getContextType_Component()

Generated

[EMF] Model

type="org.eclipse.hyades.logging.adapter.model.internal.context.Component" containment="true" required="true" transient="true" volatile="true" derived="true" extendedMetaData="kind='element' name='Component' namespace='##targetNamespace' group='#group:0'"

getDescription

java.lang.String getDescription()

Returns the value of the 'Description' attribute.

If the meaning of the 'Description' attribute isn't clear, there really should be more of a description here...

A Context Description is simply that, a detailed descriptive string, likely hilighting the the unique behavioural features of the context implementation. For example "A context that simply uses the sequential components as they are provided and assumes the first component is a sensor". This is an optional attribute and purely for documentation purposes.

Returns:

the value of the 'Description' attribute.

See Also:

setDescription(String), ContextPackage.getContextType_Description()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.xml.type.String" extendedMetaData="kind='attribute' name='description'"

setDescription

void setDescription(java.lang.String value)

Sets the value of the 'Description' attribute.

Parameters:

value - the new value of the 'Description' attribute.

See Also:

getDescription()

Generated

getExecutableClass

java.lang.String getExecutableClass()

Returns the value of the 'Executable Class' attribute.

If the meaning of the 'Executable Class' attribute isn't clear, there really should be more of a description here...

The executable class is the class that implements the context behaviour and complies with the apis required at the code level. This should be a fully package qualified class name.

Returns:

the value of the 'Executable Class' attribute.

See Also:

setExecutableClass(String), ContextPackage.getContextType_ExecutableClass()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.xml.type.String" required="true" extendedMetaData="kind='attribute' name='executableClass'"

setExecutableClass

void setExecutableClass(java.lang.String value)

Sets the value of the 'Executable Class' attribute.

Parameters:

value - the new value of the 'Executable Class' attribute.

See Also:

getExecutableClass()

Generated

getImplementationCreationDate

java.lang.Object getImplementationCreationDate()

Returns the value of the 'Implementation Creation Date' attribute.

If the meaning of the 'Implementation Creation Date' attribute isn't clear, there really should be more of a description here...

An optional attribute that provides the date this version of the component implemenation was created or built.

Returns:

the value of the 'Implementation Creation Date' attribute.

See Also:

setImplementationCreationDate(Object), ContextPackage.getContextType_ImplementationCreationDate()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.xml.type.DateTime" extendedMetaData="kind='attribute' name='implementationCreationDate'"

setImplementationCreationDate

void setImplementationCreationDate(java.lang.Object value)

Sets the value of the 'Implementation Creation Date' attribute.

Parameters:

value - the new value of the 'Implementation Creation Date' attribute.

See Also:

getImplementationCreationDate()

Generated

getImplementationVersion

java.lang.String getImplementationVersion()

Returns the value of the 'Implementation Version' attribute.

If the meaning of the 'Implementation Version' attribute isn't clear, there really should be more of a description here...

A number representing the version of the component implementation. This attribute is required.

Returns:

the value of the 'Implementation Version' attribute.

See Also:

setImplementationVersion(String), ContextPackage.getContextType_ImplementationVersion()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.xml.type.String" required="true" extendedMetaData="kind='attribute' name='implementationVersion'"

setImplementationVersion

void setImplementationVersion(java.lang.String value)

Sets the value of the 'Implementation Version' attribute.

Parameters:

value - the new value of the 'Implementation Version' attribute.

See Also:

getImplementationVersion()

Generated

getImplementationVersionDescription

java.lang.String getImplementationVersionDescription()

Returns the value of the 'Implementation Version Description' attribute.

If the meaning of the 'Implementation Version Description' attribute isn't clear, there really should be more of a description here...

n optional attribute that provides a description of the version of the component implementation.

Returns:

the value of the 'Implementation Version Description' attribute.

See Also:

setImplementationVersionDescription(String), ContextPackage.getContextType_ImplementationVersionDescription()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.xml.type.String" extendedMetaData="kind='attribute' name='implementationVersionDescription'"

setImplementationVersionDescription

void setImplementationVersionDescription(java.lang.String value)

Sets the value of the 'Implementation Version Description' attribute.

Parameters:

value - the new value of the 'Implementation Version Description' attribute.

See Also:

getImplementationVersionDescription()

Generated

getLoggingLevel

java.lang.String getLoggingLevel()

Returns the value of the 'Logging Level' attribute.

If the meaning of the 'Logging Level' attribute isn't clear, there really should be more of a description here...

All components have a logger and the logging level is used to indicate what level of logging is allowed for a component.

Returns:

the value of the 'Logging Level' attribute.

See Also:

setLoggingLevel(String), ContextPackage.getContextType_LoggingLevel()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.xml.type.String" required="true" extendedMetaData="kind='attribute' name='loggingLevel'"

setLoggingLevel

void setLoggingLevel(java.lang.String value)

Sets the value of the 'Logging Level' attribute.

Parameters:

value - the new value of the 'Logging Level' attribute.

See Also:

getLoggingLevel()

Generated

getName

java.lang.String getName()

Returns the value of the 'Name' attribute.

If the meaning of the 'Name' attribute isn't clear, there really should be more of a description here...

The context name is a simple name used to identify the context. It is a short human readable string. Typically a very small number of descriptive words that would not change over time as the context is perhaps enhanced over releases. For example "Product X error log monitor".

Returns:

the value of the 'Name' attribute.

See Also:

setName(String), ContextPackage.getContextType_Name()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.xml.type.String" required="true" extendedMetaData="kind='attribute' name='name'"

setName

void setName(java.lang.String value)

Sets the value of the 'Name' attribute.

Parameters:

value - the new value of the 'Name' attribute.

See Also:

getName()

Generated

getRole

ContextRoleNames getRole()

Returns the value of the 'Role' attribute. The default value is "context". The literals are from the enumeration ContextRoleNames.

If the meaning of the 'Role' attribute isn't clear, there really should be more of a description here...

A context is itself a component. It is a specific type of component know as a context. This is it's role. See the component role attribute for more details.

Returns:

the value of the 'Role' attribute.

See Also:

ContextRoleNames, isSetRole(), unsetRole(), setRole(ContextRoleNames), ContextPackage.getContextType_Role()

Generated

[EMF] Model

default="context" unique="false" unsettable="true" required="true" extendedMetaData="kind='attribute' name='role'"

setRole

void setRole(ContextRoleNames value)

Sets the value of the 'Role' attribute.

Parameters:

value - the new value of the 'Role' attribute.

See Also:

ContextRoleNames, isSetRole(), unsetRole(), getRole()

Generated

unsetRole

void unsetRole()

Unsets the value of the 'Role' attribute.

See Also:

isSetRole(), getRole(), setRole(ContextRoleNames)

Generated

isSetRole

boolean isSetRole()

Returns whether the value of the 'Role' attribute is set.

Returns:

whether the value of the 'Role' attribute is set.

See Also:

unsetRole(), getRole(), setRole(ContextRoleNames)

Generated

getRoleCreationDate

java.lang.Object getRoleCreationDate()

Returns the value of the 'Role Creation Date' attribute.

If the meaning of the 'Role Creation Date' attribute isn't clear, there really should be more of a description here...

An optional attribute that provides the date this version of the role definition was created or published.

Returns:

the value of the 'Role Creation Date' attribute.

See Also:

setRoleCreationDate(Object), ContextPackage.getContextType_RoleCreationDate()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.xml.type.DateTime" extendedMetaData="kind='attribute' name='roleCreationDate'"

setRoleCreationDate

void setRoleCreationDate(java.lang.Object value)

Sets the value of the 'Role Creation Date' attribute.

Parameters:

value - the new value of the 'Role Creation Date' attribute.

See Also:

getRoleCreationDate()

Generated

getRoleVersion

java.lang.String getRoleVersion()

Returns the value of the 'Role Version' attribute.

If the meaning of the 'Role Version' attribute isn't clear, there really should be more of a description here...

A number representing the version of the role defintion. This attribute is required.

Returns:

the value of the 'Role Version' attribute.

See Also:

setRoleVersion(String), ContextPackage.getContextType_RoleVersion()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.xml.type.String" required="true" extendedMetaData="kind='attribute' name='roleVersion'"

setRoleVersion

void setRoleVersion(java.lang.String value)

Sets the value of the 'Role Version' attribute.

Parameters:

value - the new value of the 'Role Version' attribute.

See Also:

getRoleVersion()

Generated

getRoleVersionDescription

java.lang.String getRoleVersionDescription()

Returns the value of the 'Role Version Description' attribute.

If the meaning of the 'Role Version Description' attribute isn't clear, there really should be more of a description here...

An optional attribute that provides a description of the version of the role definition.

Returns:

the value of the 'Role Version Description' attribute.

See Also:

setRoleVersionDescription(String), ContextPackage.getContextType_RoleVersionDescription()

Generated

[EMF] Model

unique="false" dataType="org.eclipse.emf.ecore.xml.type.String" extendedMetaData="kind='attribute' name='roleVersionDescription'"

setRoleVersionDescription

void setRoleVersionDescription(java.lang.String value)

Sets the value of the 'Role Version Description' attribute.

Parameters:

value - the new value of the 'Role Version Description' attribute.

See Also:

getRoleVersionDescription()

Generated

getUniqueID

java.lang.String getUniqueID()

Returns the value of the 'Unique ID' attribute.

If the meaning of the 'Unique ID' attribute isn't clear, there really should be more of a description here...

The unique ID is used to uniquely identify the specific context instance in the adapter. See the component unique ID description for more information.

Returns:

the value of the 'Unique ID' attribute.

See Also:

setUniqueID(String), ContextPackage.getContextType_UniqueID()

Generated

[EMF] Model

unique="false" id="true" dataType="org.eclipse.emf.ecore.xml.type.ID" required="true" extendedMetaData="kind='attribute' name='uniqueID'"

setUniqueID

void setUniqueID(java.lang.String value)

Sets the value of the 'Unique ID' attribute.

Parameters:

value - the new value of the 'Unique ID' attribute.

See Also:

getUniqueID()

Generated