org.eclipse.tptp.platform.analysis.engine
Interface IAlgorithm

All Superinterfaces:

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

All Known Subinterfaces:

IResourceAlgorithm, ITemplateAlgorithm, ITypeCountAlgorithm, ITypeCountTemplate

All Known Implementing Classes:

IAlgorithmImpl, IResourceAlgorithmImpl, ITemplateAlgorithmImpl, ITypeCountAlgorithmImpl

public interface IAlgorithm

extends org.eclipse.emf.ecore.EObject

A representation of the model object 'IAlgorithm'. Abstraction for representing an algorithm. Each algorithm has associated list of data on which algorithm will execute.

The following features are supported:

• Name
• Type
• Xml File URL
• Parameters

See Also:

EnginePackage.getIAlgorithm()

Method Summary

void	addData(IData data)
ICategory	getCategory()
java.util.List	getData()
IData[]	getEnabledData() pre: the data field must already be populated
java.lang.String	getName() Returns the value of the 'Name' attribute.
org.eclipse.emf.common.util.EList	getParameters() Returns the value of the 'Parameters' containment reference list.
java.lang.String	getTitle(IData algorithmData)
java.lang.String	getType() Returns the value of the 'Type' attribute.
java.net.URL	getXmlFileURL() Returns the value of the 'Xml File URL' attribute.
boolean	isQuick()
void	setCategory(ICategory cat)
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.
void	setXmlFileURL(java.net.URL value) Sets the value of the 'Xml File URL' attribute.
boolean	supports(IData data)

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

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

Returns:

the value of the 'Name' attribute.

See Also:

setName(String), EnginePackage.getIAlgorithm_Name()

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

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

Returns:

the value of the 'Type' attribute.

See Also:

setType(String), EnginePackage.getIAlgorithm_Type()

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

getXmlFileURL

public java.net.URL getXmlFileURL()

Returns the value of the 'Xml File URL' attribute.

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

Returns:

the value of the 'Xml File URL' attribute.

See Also:

setXmlFileURL(URL), EnginePackage.getIAlgorithm_XmlFileURL()

setXmlFileURL

public void setXmlFileURL(java.net.URL value)

Sets the value of the 'Xml File URL' attribute.

Parameters:

value - the new value of the 'Xml File URL' attribute.

See Also:

getXmlFileURL()

getParameters

public org.eclipse.emf.common.util.EList getParameters()

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

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

Returns:

the value of the 'Parameters' containment reference list.

See Also:

EnginePackage.getIAlgorithm_Parameters()

getTitle

public java.lang.String getTitle(IData algorithmData)

supports

public boolean supports(IData data)

isQuick

public boolean isQuick()

getData

public java.util.List getData()

addData

public void addData(IData data)

setCategory

public void setCategory(ICategory cat)

getCategory

public ICategory getCategory()

getEnabledData

public IData[] getEnabledData()

pre: the data field must already be populated

Returns:

all the enabled data associated with this algorithm