TPTP 4.5.0 Platform Project
Public API Specification

org.eclipse.hyades.models.hierarchy.extensions
Interface SimpleSearchQuery

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier, Query
All Known Subinterfaces:
CorrelationQuery, TimeBasedCorrelationQuery
All Known Implementing Classes:
CorrelationQueryImpl, SimpleSearchQueryImpl, TimeBasedCorrelationQueryImpl

public interface SimpleSearchQuery
extends Query

A representation of the model object 'Simple Search Query'.

The following features are supported:

See Also:
ExtensionsPackage.getSimpleSearchQuery()
Generated
[EMF] Model

Method Summary
 int getMaxElements()
          Returns the value of the 'Max Elements' attribute
 org.eclipse.emf.common.util.EList getOrderByExpresions()
          Returns the value of the 'Order By Expresions' containment reference list.
 int getStartWith()
          Returns the value of the 'Start With' attribute
 WhereExpression getWhereExpression()
          Returns the value of the 'Where Expression' containment reference.
 void setMaxElements(int value)
          Sets the value of the 'Max Elements' attribute
 void setStartWith(int value)
          Sets the value of the 'Start With' attribute
 void setWhereExpression(WhereExpression value)
          Sets the value of the 'Where Expression' containment reference
 
Methods inherited from interface org.eclipse.hyades.models.hierarchy.extensions.Query
getAnnotations, getName, getOutputElements, getQuery, getRequiredPaths, getSources, getSubQuery, isCount, isDistinct, setCount, setDistinct, setName, setQuery
 
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

getMaxElements

int getMaxElements()
Returns the value of the 'Max Elements' attribute. Maximum number of returned elements.

Returns:
the value of the 'Max Elements' attribute.
See Also:
setMaxElements(int), ExtensionsPackage.getSimpleSearchQuery_MaxElements()
Generated
[EMF] Model

setMaxElements

void setMaxElements(int value)
Sets the value of the 'Max Elements' attribute.

Parameters:
value - the new value of the 'Max Elements' attribute.
See Also:
getMaxElements()
Generated

getStartWith

int getStartWith()
Returns the value of the 'Start With' attribute. The starting index in the result set from where we will return the values, if negative it will be relative to the end of the result set.

Returns:
the value of the 'Start With' attribute.
See Also:
setStartWith(int), ExtensionsPackage.getSimpleSearchQuery_StartWith()
Generated
[EMF] Model

setStartWith

void setStartWith(int value)
Sets the value of the 'Start With' attribute.

Parameters:
value - the new value of the 'Start With' attribute.
See Also:
getStartWith()
Generated

getOrderByExpresions

org.eclipse.emf.common.util.EList getOrderByExpresions()
Returns the value of the 'Order By Expresions' containment reference list. The list contents are of type OrderByElement. It is bidirectional and its opposite is 'Search Query'.

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

Returns:
the value of the 'Order By Expresions' containment reference list.
See Also:
ExtensionsPackage.getSimpleSearchQuery_OrderByExpresions(), OrderByElement.getSearchQuery()
Generated
[EMF] Model
type="org.eclipse.hyades.models.hierarchy.extensions.OrderByElement" opposite="searchQuery" containment="true"

getWhereExpression

WhereExpression getWhereExpression()
Returns the value of the 'Where Expression' containment reference. It is bidirectional and its opposite is 'Search Query'.

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

Returns:
the value of the 'Where Expression' containment reference.
See Also:
setWhereExpression(WhereExpression), ExtensionsPackage.getSimpleSearchQuery_WhereExpression(), WhereExpression.getSearchQuery()
Generated
[EMF] Model
opposite="searchQuery" containment="true"

setWhereExpression

void setWhereExpression(WhereExpression value)
Sets the value of the 'Where Expression' containment reference.

Parameters:
value - the new value of the 'Where Expression' containment reference.
See Also:
getWhereExpression()
Generated

TPTP 4.5.0 Platform Project
Public API Specification