TPTP 4.2.0 Platform Project
Public API Specification

org.eclipse.hyades.models.hierarchy
Interface CorrelationEngine

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Implementing Classes:
CorrelationEngineImpl

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

A representation of the model object 'Correlation Engine'. The id should uniquely identify the engine.

The following features are supported:

See Also:
HierarchyPackage.getCorrelationEngine()
Generated
[EMF] Model

Method Summary
 CorrelationContainerProxy getCorrelationContainerProxy()
          Returns the value of the 'Correlation Container Proxy' container reference.
 java.lang.String getDescription()
          Returns the value of the 'Description' attribute
 java.lang.String getId()
          Returns the value of the 'Id' attribute
 java.lang.String getName()
          Returns the value of the 'Name' attribute
 java.lang.String getType()
          Returns the value of the 'Type' attribute
 void setCorrelationContainerProxy(CorrelationContainerProxy value)
          Sets the value of the 'Correlation Container Proxy' container reference
 void setDescription(java.lang.String value)
          Sets the value of the 'Description' attribute
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute
 void setType(java.lang.String value)
          Sets the value of the 'Type' 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

getType

public java.lang.String getType()
Returns the value of the 'Type' attribute.

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

Engines are typed with this attribute. Examples of types are "Correlation based on URI", "root"

Returns:
the value of the 'Type' attribute.
See Also:
setType(String), HierarchyPackage.getCorrelationEngine_Type()
Generated
[EMF] Model

setType

public void setType(java.lang.String value)
Sets the value of the 'Type' attribute.

Parameters:
value - the new value of the 'Type' attribute.
See Also:
getType()
Generated

getName

public 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...

Each engine has a name. This is not ensured to be unique. The name is intended to be human readable.

Returns:
the value of the 'Name' attribute.
See Also:
setName(String), HierarchyPackage.getCorrelationEngine_Name()
Generated
[EMF] Model

setName

public 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

getId

public java.lang.String getId()
Returns the value of the 'Id' attribute.

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

The id of an engine is something that uniquely identifes the engine from all other engines installed. The uniqueness is managed outside the model and is the responsibility of the engine provider.

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), HierarchyPackage.getCorrelationEngine_Id()
Generated
[EMF] Model

setId

public void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated

getDescription

public java.lang.String getDescription()
Returns the value of the 'Description' attribute. The description of this engine

Returns:
the value of the 'Description' attribute.
See Also:
setDescription(String), HierarchyPackage.getCorrelationEngine_Description()
Generated
[EMF] Model

setDescription

public 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

getCorrelationContainerProxy

public CorrelationContainerProxy getCorrelationContainerProxy()
Returns the value of the 'Correlation Container Proxy' container reference. It is bidirectional and its opposite is 'Correlation Engine'.

If the meaning of the 'Correlation Container Proxy' container reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Correlation Container Proxy' container reference.
See Also:
setCorrelationContainerProxy(CorrelationContainerProxy), HierarchyPackage.getCorrelationEngine_CorrelationContainerProxy(), CorrelationContainerProxy.getCorrelationEngine()
Generated
[EMF] Model
opposite="correlationEngine"

setCorrelationContainerProxy

public void setCorrelationContainerProxy(CorrelationContainerProxy value)
Sets the value of the 'Correlation Container Proxy' container reference.

Parameters:
value - the new value of the 'Correlation Container Proxy' container reference.
See Also:
getCorrelationContainerProxy()
Generated

TPTP 4.2.0 Platform Project
Public API Specification