iot.jcypher.domainquery.api

Class TraversalStep

java.lang.Object

iot.jcypher.domainquery.api.APIObject

iot.jcypher.domainquery.api.TraversalStep

public class TraversalStep
extends APIObject

Field Summary

Fields inherited from class iot.jcypher.domainquery.api.APIObject

astObject

Method Summary

Methods

Modifier and Type	Method and Description
TraversalStep	BACK(String attributeName) Traverse backward via an attribute
TraversalStep	DISTANCE(int minDistance, int maxDistance) Define the distance in terms of how many hops to take when navigating the domain graph along a given attribute.
TraversalStep	FORTH(String attributeName) Traverse forward via an attribute
DomainObjectMatch<DomainObject>	TO_GENERIC(String domainObjectTypeName) End the traversal of the domain object graph matching a specific type of domain objects.
<T> DomainObjectMatch<T>	TO(Class<T> domainObjectType) End the traversal of the domain object graph matching a specific type of domain objects

Methods inherited from class java.lang.Object

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

Method Detail

FORTH

public TraversalStep FORTH(String attributeName)

Traverse forward via an attribute

Parameters:

attributeName -

Returns:

BACK

public TraversalStep BACK(String attributeName)

Traverse backward via an attribute

Parameters:

attributeName -

Returns:

DISTANCE

public TraversalStep DISTANCE(int minDistance,
                     int maxDistance)

Define the distance in terms of how many hops to take when navigating the domain graph along a given attribute. The default is one hop (minDistance = maxDistance = 1), maxDistance -1 means hop as far as you will get (either to a leaf in the graph or to a detected loop).

Parameters:

minDistance - the minimum number of hops to navigate

maxDistance - the maximum number of hops to navigate

Returns:

TO

public <T> DomainObjectMatch<T> TO(Class<T> domainObjectType)

End the traversal of the domain object graph matching a specific type of domain objects

Parameters:

domainObjectType -

Returns:

a DomainObjectMatch

TO_GENERIC

public DomainObjectMatch<DomainObject> TO_GENERIC(String domainObjectTypeName)

End the traversal of the domain object graph matching a specific type of domain objects. TO_GENERIC is used when navigating a generic domain model.

Parameters:

domainObjectTypeName -

Returns:

a DomainObjectMatch