org.eclipse.hyades.analysis.engine
Class Directive

java.lang.Object
  org.eclipse.hyades.analysis.engine.Directive

public class Directive

extends java.lang.Object

Class defining a directive element in a symptom database. A directive is used to recommend actions to be taken by the user in order to solve a symptom. A directive can contain a human readable description of the action to be taken or a directiveString specifying an action to be executed by a program or both.

Constructor Summary

Directive(java.lang.String id)
Convenience constructor for creating a Directive with the parameter unique identifier but no associated action to be executed and no English description.

Directive(java.lang.String id, java.lang.String directiveString)
Convenience constructor for creating a Directive with the parameter unique identifier and associated action to be executed but no English description.

Directive(java.lang.String id, java.lang.String directiveString, java.lang.String description)
Constructor for creating a Directive with the parameter unique identifier, associated action to be executed and English description.

Method Summary

boolean	equals(java.lang.Object object) Overrides java.lang.Object.equals() to indicate whether some other object is "equal to" this Directive object.
java.lang.String	getDescription() Gets the English description.
java.lang.String	getDirectiveString() Gets the associated action to be executed.
java.lang.String	getId() Gets the unique identifier.
void	setDescription(java.lang.String description) Sets the English description.
void	setDirectiveString(java.lang.String directiveString) Sets the associated action to be executed.
void	setId(java.lang.String id) Sets the unique identifier.
java.lang.String	toString() Overrides java.lang.Object.toString() to return a string representation of this Directive object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Directive

public Directive(java.lang.String id)

Convenience constructor for creating a Directive with the parameter unique identifier but no associated action to be executed and no English description.

Parameters:

id - the unique identifier

See Also:

Directive(String,String,String)

Directive

public Directive(java.lang.String id,
                 java.lang.String directiveString)

Convenience constructor for creating a Directive with the parameter unique identifier and associated action to be executed but no English description.

Parameters:

id - the unique identifier

directiveString - the associated action to be executed

See Also:

Directive(String,String,String)

Directive

public Directive(java.lang.String id,
                 java.lang.String directiveString,
                 java.lang.String description)

Constructor for creating a Directive with the parameter unique identifier, associated action to be executed and English description.

Parameters:

id - the unique identifier

directiveString - the associated action to be executed

description - the English description

Method Detail

setId

public void setId(java.lang.String id)

Sets the unique identifier.

Parameters:

id - the unique identifier

See Also:

getId()

getId

public java.lang.String getId()

Gets the unique identifier.

Returns:

the unique identifier

See Also:

setId(String)

setDirectiveString

public void setDirectiveString(java.lang.String directiveString)

Sets the associated action to be executed.

Parameters:

directiveString - the associated action to be executed

See Also:

getDirectiveString()

getDirectiveString

public java.lang.String getDirectiveString()

Gets the associated action to be executed.

Returns:

the associated action to be executed

See Also:

setDirectiveString(String)

setDescription

public void setDescription(java.lang.String description)

Sets the English description.

Parameters:

description - the English description

See Also:

getDescription()

getDescription

public java.lang.String getDescription()

Gets the English description.

Returns:

the English description

See Also:

setDescription(String)

equals

public boolean equals(java.lang.Object object)

Overrides java.lang.Object.equals() to indicate whether some other object is "equal to" this Directive object.

Parameters:

object - the reference object with which to compare.

Returns:

true if this object is the same as the object argument otherwise false.

toString

public java.lang.String toString()

Overrides java.lang.Object.toString() to return a string representation of this Directive object.

Returns:

the string representation of this object.