org.eclipse.viatra.transformation.views.traceability.patterns

Class Helpers

java.lang.Object

org.eclipse.viatra.query.runtime.api.impl.BaseQueryGroup

org.eclipse.viatra.query.runtime.api.impl.BaseGeneratedPatternGroup

org.eclipse.viatra.transformation.views.traceability.patterns.Helpers

All Implemented Interfaces:

IQueryGroup

public final class Helpers
extends BaseGeneratedPatternGroup

A pattern group formed of all public patterns defined in helpers.vql.

Use the static instance as any org.eclipse.viatra.query.runtime.api.IPatternGroup, to conveniently prepare a VIATRA Query engine for matching all patterns originally defined in file helpers.vql, in order to achieve better performance than one-by-one on-demand matcher initialization.

From package org.eclipse.viatra.transformation.views.traceability.patterns, the group contains the definition of the following patterns:

• emptyTrace
• trace2target
• trace2param
• trace2object
• param2target
• trace

See Also:

IPatternGroup

Field Summary

Fields inherited from class org.eclipse.viatra.query.runtime.api.impl.BaseGeneratedPatternGroup

querySpecifications

Method Summary

Modifier and Type	Method and Description
EmptyTraceQuerySpecification	getEmptyTrace()
EmptyTraceMatcher	getEmptyTrace(ViatraQueryEngine engine)
Param2targetQuerySpecification	getParam2target()
Param2targetMatcher	getParam2target(ViatraQueryEngine engine)
TraceQuerySpecification	getTrace()
TraceMatcher	getTrace(ViatraQueryEngine engine)
Trace2objectQuerySpecification	getTrace2object()
Trace2objectMatcher	getTrace2object(ViatraQueryEngine engine)
Trace2paramQuerySpecification	getTrace2param()
Trace2paramMatcher	getTrace2param(ViatraQueryEngine engine)
Trace2targetQuerySpecification	getTrace2target()
Trace2targetMatcher	getTrace2target(ViatraQueryEngine engine)
static Helpers	instance() Access the pattern group.

Methods inherited from class org.eclipse.viatra.query.runtime.api.impl.BaseGeneratedPatternGroup

getSpecifications

Methods inherited from class org.eclipse.viatra.query.runtime.api.impl.BaseQueryGroup

prepare, prepare

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static Helpers instance()
                        throws ViatraQueryException

Access the pattern group.

Returns:

the singleton instance of the group

Throws:

ViatraQueryException - if there was an error loading the generated code of pattern specifications

getEmptyTrace

public EmptyTraceQuerySpecification getEmptyTrace()
                                           throws ViatraQueryException

Throws:

ViatraQueryException

getEmptyTrace

public EmptyTraceMatcher getEmptyTrace(ViatraQueryEngine engine)
                                throws ViatraQueryException

Throws:

ViatraQueryException

getTrace2target

public Trace2targetQuerySpecification getTrace2target()
                                               throws ViatraQueryException

Throws:

ViatraQueryException

getTrace2target

public Trace2targetMatcher getTrace2target(ViatraQueryEngine engine)
                                    throws ViatraQueryException

Throws:

ViatraQueryException

getTrace2param

public Trace2paramQuerySpecification getTrace2param()
                                             throws ViatraQueryException

Throws:

ViatraQueryException

getTrace2param

public Trace2paramMatcher getTrace2param(ViatraQueryEngine engine)
                                  throws ViatraQueryException

Throws:

ViatraQueryException

getTrace2object

public Trace2objectQuerySpecification getTrace2object()
                                               throws ViatraQueryException

Throws:

ViatraQueryException

getTrace2object

public Trace2objectMatcher getTrace2object(ViatraQueryEngine engine)
                                    throws ViatraQueryException

Throws:

ViatraQueryException

getParam2target

public Param2targetQuerySpecification getParam2target()
                                               throws ViatraQueryException

Throws:

ViatraQueryException

getParam2target

public Param2targetMatcher getParam2target(ViatraQueryEngine engine)
                                    throws ViatraQueryException

Throws:

ViatraQueryException

getTrace

public TraceQuerySpecification getTrace()
                                 throws ViatraQueryException

Throws:

ViatraQueryException

getTrace

public TraceMatcher getTrace(ViatraQueryEngine engine)
                      throws ViatraQueryException

Throws:

ViatraQueryException