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

All Superinterfaces:

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

All Known Implementing Classes:

ComponentImpl

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

A representation of the model object 'Component'. This type describes a loadable component, by providing the executable class name and descriptive information for the purpose of compatability checking for the component. A component provides a stage of processing within a context. There is a minmal interface contract between the context and the components it uses. As long as a component implements the interface it can be managed by a context. The role of the component is optionally used by a context implementation to determine how to manage and leverage the component.

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.getComponent()

Generated

[EMF] Model

extendedMetaData="name='component' 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
RoleNames	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(RoleNames 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...

A component is allowed to have sub components. If this is the case, it is completely up to the component to understand how to use these sub-components as well as how to manage them as components in the overall context in the adapter.

Returns:

the value of the 'Group' attribute list.

See Also:

ContextPackage.getComponent_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.getComponent_Component()

Generated

[EMF] Model

type="org.eclipse.hyades.logging.adapter.model.internal.context.Component" containment="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 Component description is simply that, a detailed descriptive string, likely hilighting the the unique behavioural features of the context implementation. For example "A sensor of a single file in the local file system and monitors updates based on a timer". This is an optional attribute and purely for documentation purposes.

Returns:

the value of the 'Description' attribute.

See Also:

setDescription(String), ContextPackage.getComponent_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 component 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.getComponent_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.getComponent_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.getComponent_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.getComponent_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 ot indicate what level of logging is allowed for a component.

Returns:

the value of the 'Logging Level' attribute.

See Also:

setLoggingLevel(String), ContextPackage.getComponent_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 component name is a simple name used to identify the component. It is a short human readable string. Typically a very small number of descriptive words that would not change over time as the component is perhaps enhanced over releases. For example "local file system sensor".

Returns:

the value of the 'Name' attribute.

See Also:

setName(String), ContextPackage.getComponent_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

RoleNames getRole()

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

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

A component plays a specific role in a given context or parent component in the sense that it provides a specific type of processing within the context. There are a specific set of phases that are promoted by the adapter and these are described in the roleNames schema of this schema. A key reason for typing or categorizing a component is to allow a context or parent component to categorically leverage the component. For example a context implementation may just use each component in the order they are declared in this schema. However the context may also determine the processing order base on the role of the component.

Returns:

the value of the 'Role' attribute.

See Also:

RoleNames, isSetRole(), unsetRole(), setRole(RoleNames), ContextPackage.getComponent_Role()

Generated

[EMF] Model

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

setRole

void setRole(RoleNames value)

Sets the value of the 'Role' attribute.

Parameters:

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

See Also:

RoleNames, isSetRole(), unsetRole(), getRole()

Generated

unsetRole

void unsetRole()

Unsets the value of the 'Role' attribute.

See Also:

isSetRole(), getRole(), setRole(RoleNames)

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(RoleNames)

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.getComponent_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.getComponent_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.getComponent_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 component instance in the adapter. This is the primary way the instance in this config is connected with a component configuration in the component configuration xml file that will be associated with a running adapter. This is needed because a given component implemenation may be used multiple times within an adapter. In the case of a context, the adapter may be running and monitoring dozens of data sources, but all the context implementations may in fact be the same executable class etcetera.

Returns:

the value of the 'Unique ID' attribute.

See Also:

setUniqueID(String), ContextPackage.getComponent_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