GASService.Options (Blazegraph Database Platform 2.1.5 API)

Enclosing class:: GASService

public static interface GASService.Options

Field Summary

Fields
Modifier and Type	Field and Description
`static TraversalDirectionEnum`	`DEFAULT_DIRECTED_TRAVERSAL`
`static int`	`DEFAULT_MAX_ITERATIONS`
`static int`	`DEFAULT_MAX_ITERATIONS_AFTER_TARGETS`
`static int`	`DEFAULT_MAX_VISITED`
`static int`	`DEFAULT_NTHREADS`
`static Class<? extends IGASSchedulerImpl>`	`DEFAULT_SCHEDULER`
`static org.openrdf.model.URI`	`GAS_CLASS` Magic predicate identifies the fully qualified class name of the `IGASProgram` to be executed.
`static org.openrdf.model.URI`	`IN` Magic predicate used to specify one (or more) vertices in the initial frontier.
`static org.openrdf.model.URI`	`LINK_ATTR_TYPE` An optional constraint on the types of the link attributes that will be visited by the algorithm - the use of this option is required if you want to process some specific link weight rather than the simple topology of the graph.
`static org.openrdf.model.URI`	`LINK_TYPE` An optional constraint on the types of links that will be visited by the algorithm.
`static org.openrdf.model.URI`	`MAX_ITERATIONS` The maximum #of iterations for the GAS program (optional, default 2147483647).
`static org.openrdf.model.URI`	`MAX_ITERATIONS_AFTER_TARGETS` The maximum #of iterations for the GAS program after the targets have been reached (optional, default 2147483647).
`static org.openrdf.model.URI`	`MAX_VISITED` The maximum #of vertices in the visited set for the GAS program (optional, default 2147483647).
`static String`	`NAMESPACE` The namespace used for bigdata GAS API.
`static org.openrdf.model.URI`	`NTHREADS` The #of threads that will be used to expand the frontier in each iteration of the algorithm (optional, default 4).
`static org.openrdf.model.URI`	`OUT` Magic predicate used to specify a variable that will become bound to each vertex in the visited set for the analytic.
`static org.openrdf.model.URI`	`OUT1`
`static org.openrdf.model.URI`	`OUT2`
`static org.openrdf.model.URI`	`OUT3`
`static org.openrdf.model.URI`	`OUT4`
`static org.openrdf.model.URI`	`OUT5`
`static org.openrdf.model.URI`	`OUT6`
`static org.openrdf.model.URI`	`OUT7`
`static org.openrdf.model.URI`	`OUT8`
`static org.openrdf.model.URI`	`OUT9`
`static org.openrdf.model.URI`	`PROGRAM` Used as the subject in the GAS SERVICE invocation pattern.
`static org.openrdf.model.URI`	`SCHEDULER_CLASS` The `IGASScheduler` (default is `DEFAULT_SCHEDULER`).
`static org.openrdf.model.URI`	`SERVICE_KEY` The URL at which the `GASService` will respond.
`static org.openrdf.model.URI`	`TARGET` Magic predicate used to specify one (or more) target vertices.
`static org.openrdf.model.URI`	`TRAVERSAL_DIRECTION` This option determines the traversal direction semantics for the `IGASProgram` against the graph, including whether the the edges of the graph will be interpreted as directed ( `TraversalDirectionEnum.Forward` (which is the default), `TraversalDirectionEnum.Reverse`), or `TraversalDirectionEnum.Undirected`.

- Field Detail
  - NAMESPACE
```
static final String NAMESPACE
```
    The namespace used for bigdata GAS API.
    
    See Also:
    Constant Field Values
  - SERVICE_KEY
```
static final org.openrdf.model.URI SERVICE_KEY
```
    The URL at which the GASService will respond.
  - PROGRAM
```
static final org.openrdf.model.URI PROGRAM
```
    Used as the subject in the GAS SERVICE invocation pattern.
  - GAS_CLASS
```
static final org.openrdf.model.URI GAS_CLASS
```
    Magic predicate identifies the fully qualified class name of the IGASProgram to be executed.
  - NTHREADS
```
static final org.openrdf.model.URI NTHREADS
```
    The #of threads that will be used to expand the frontier in each iteration of the algorithm (optional, default 4).
    
    See Also:
    DEFAULT_NTHREADS
  - DEFAULT_NTHREADS
```
static final int DEFAULT_NTHREADS
```
    See Also:
    Constant Field Values
  - TRAVERSAL_DIRECTION
```
static final org.openrdf.model.URI TRAVERSAL_DIRECTION
```
    This option determines the traversal direction semantics for the IGASProgram against the graph, including whether the the edges of the graph will be interpreted as directed ( TraversalDirectionEnum.Forward (which is the default), TraversalDirectionEnum.Reverse), or TraversalDirectionEnum.Undirected.
    
    See Also:
    TraversalDirectionEnum, IGASContext.setTraversalDirection(TraversalDirectionEnum)
  - DEFAULT_DIRECTED_TRAVERSAL
```
static final TraversalDirectionEnum DEFAULT_DIRECTED_TRAVERSAL
```
  - MAX_ITERATIONS
```
static final org.openrdf.model.URI MAX_ITERATIONS
```
    The maximum #of iterations for the GAS program (optional, default 2147483647).
    
    See Also:
    DEFAULT_MAX_ITERATIONS, IGASContext.setMaxIterations(int)
  - DEFAULT_MAX_ITERATIONS
```
static final int DEFAULT_MAX_ITERATIONS
```
    See Also:
    Constant Field Values
  - MAX_ITERATIONS_AFTER_TARGETS
```
static final org.openrdf.model.URI MAX_ITERATIONS_AFTER_TARGETS
```
    The maximum #of iterations for the GAS program after the targets have been reached (optional, default 2147483647). Default behavior is to not stop once the targets are reached.
    
    See Also:
    DEFAULT_MAX_ITERATIONS_AFTER_TARGETS, IGASContext.setMaxIterationsAfterTargets(int)
  - DEFAULT_MAX_ITERATIONS_AFTER_TARGETS
```
static final int DEFAULT_MAX_ITERATIONS_AFTER_TARGETS
```
    See Also:
    Constant Field Values
  - MAX_VISITED
```
static final org.openrdf.model.URI MAX_VISITED
```
    The maximum #of vertices in the visited set for the GAS program (optional, default 2147483647).
    
    See Also:
    DEFAULT_MAX_VISITED, IGASContext.setMaxVisited(int)
  - DEFAULT_MAX_VISITED
```
static final int DEFAULT_MAX_VISITED
```
    See Also:
    Constant Field Values
  - LINK_TYPE
```
static final org.openrdf.model.URI LINK_TYPE
```
    An optional constraint on the types of links that will be visited by the algorithm.
    Note: When this option is used, the scatter and gather will not visit the property set for the vertex. Instead, the graph is treated as if it were an unattributed graph and only mined for the connectivity data (which may include a link weight).
    
    See Also:
    IGASContext.setLinkType(URI)
  - LINK_ATTR_TYPE
```
static final org.openrdf.model.URI LINK_ATTR_TYPE
```
    An optional constraint on the types of the link attributes that will be visited by the algorithm - the use of this option is required if you want to process some specific link weight rather than the simple topology of the graph.
    
    See Also:
    IGASContext.setLinkAttributeType(URI)
  - SCHEDULER_CLASS
```
static final org.openrdf.model.URI SCHEDULER_CLASS
```
    The IGASScheduler (default is DEFAULT_SCHEDULER). Class must implement IGASSchedulerImpl.
  - DEFAULT_SCHEDULER
```
static final Class<? extends IGASSchedulerImpl> DEFAULT_SCHEDULER
```
  - IN
```
static final org.openrdf.model.URI IN
```
    Magic predicate used to specify one (or more) vertices in the initial frontier.
    Note: Algorithms such as CC and PR automatically place all vertices into the initial frontier. For such algorithms, you do not need to specify IN.
  - TARGET
```
static final org.openrdf.model.URI TARGET
```
    Magic predicate used to specify one (or more) target vertices. This may be used in combination with algorithms that compute paths in a graph to filter the visited vertices after the traversal in order to remove any vertex that is not part of a path to one or more of the specified target vertices.
    In order to support this, the algorithm has to have a concept of a predecessor. For each target, the set of visited vertices is checked to see if the target was reachable. If it was reachable, then the predecessors are walked backwards until a starting vertex is reached (predecessor:=null). Each such predecessor is added to a list of vertices to be retained. This is repeated for each target. Once we have identified the combined list of vertices to be reained, all vertices NOT in that list are removed from the visited vertex state. This causes the algorithm to only report on those paths that lead to at least one of the specified target vertices.
    Note: If you do not care about the distance between two vertices, but only whether they are reachable from one another, you can put both vertices into the initial frontier. The algorithm will then work from both points which can accelerate convergence.
  - OUT
```
static final org.openrdf.model.URI OUT
```
    Magic predicate used to specify a variable that will become bound to each vertex in the visited set for the analytic. OUT is always bound to the visited vertices. The other "out" variables are bound to state associated with the visited vertices in an algorithm dependent manner.
    
    See Also:
    IBindingExtractor.getBinderList()
  - OUT1
```
static final org.openrdf.model.URI OUT1
```
  - OUT2
```
static final org.openrdf.model.URI OUT2
```
  - OUT3
```
static final org.openrdf.model.URI OUT3
```
  - OUT4
```
static final org.openrdf.model.URI OUT4
```
  - OUT5
```
static final org.openrdf.model.URI OUT5
```
  - OUT6
```
static final org.openrdf.model.URI OUT6
```
  - OUT7
```
static final org.openrdf.model.URI OUT7
```
  - OUT8
```
static final org.openrdf.model.URI OUT8
```
  - OUT9
```
static final org.openrdf.model.URI OUT9
```

Interface GASService.Options

Field Summary

Field Detail

NAMESPACE

SERVICE_KEY

PROGRAM

GAS_CLASS

NTHREADS

DEFAULT_NTHREADS

TRAVERSAL_DIRECTION

DEFAULT_DIRECTED_TRAVERSAL

MAX_ITERATIONS

DEFAULT_MAX_ITERATIONS

MAX_ITERATIONS_AFTER_TARGETS

DEFAULT_MAX_ITERATIONS_AFTER_TARGETS

MAX_VISITED

DEFAULT_MAX_VISITED

LINK_TYPE

LINK_ATTR_TYPE

SCHEDULER_CLASS

DEFAULT_SCHEDULER

IN

TARGET

OUT

OUT1

OUT2

OUT3

OUT4

OUT5

OUT6

OUT7

OUT8

OUT9