TPTP 4.1.0 Platform Project
Public API Specification

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

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

public interface IMatch
extends IResult

A representation of the model object 'IMatch'. The match class is an abstraction for result of a successful application of a rule to the resource(s). The match contains the collection of links to places in resources that collectively represent the match.

The following features are supported:

See Also:
EnginePackage.getIMatch()

Method Summary
 org.eclipse.emf.common.util.EList getLinks()
          Returns the value of the 'Links' containment reference list.
 MatchStatus getStatus()
          Returns the value of the 'Status' attribute.
 void setStatus(MatchStatus value)
          Sets the value of the 'Status' attribute.
 
Methods inherited from interface org.eclipse.tptp.platform.analysis.engine.IResult
getAlgorithmName, getCategoryName, getDataName, setAlgorithmName, setCategoryName, setDataName
 
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

getStatus

public MatchStatus getStatus()
Returns the value of the 'Status' attribute. The literals are from the enumeration MatchStatus. The status of the match, used to keep track of ignored matches, fixed problem, problems submited to bug tracker, etc.

Returns:
the value of the 'Status' attribute.
See Also:
MatchStatus, setStatus(MatchStatus), EnginePackage.getIMatch_Status()

setStatus

public void setStatus(MatchStatus value)
Sets the value of the 'Status' attribute.

Parameters:
value - the new value of the 'Status' attribute.
See Also:
MatchStatus, getStatus()

getLinks

public org.eclipse.emf.common.util.EList getLinks()
Returns the value of the 'Links' containment reference list. The list contents are of type IMatchLink.

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

Returns:
the value of the 'Links' containment reference list.
See Also:
EnginePackage.getIMatch_Links()

TPTP 4.1.0 Platform Project
Public API Specification