org.apache.tinkerpop.gremlin.tinkergraph.services

Class TinkerTextSearchFactory<I,R>

java.lang.Object

org.apache.tinkerpop.gremlin.tinkergraph.services.TinkerServiceRegistry.TinkerServiceFactory<I,R>

org.apache.tinkerpop.gremlin.tinkergraph.services.TinkerTextSearchFactory<I,R>

All Implemented Interfaces:

AutoCloseable, Service<I,R>, Service.ServiceFactory<I,R>

public class TinkerTextSearchFactory<I,R>
extends TinkerServiceRegistry.TinkerServiceFactory<I,R>
implements Service<I,R>

Inefficient text search implementation (scan+filter), searches for Propertys by token/regex. Demonstrates a Service.Type#Start service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TinkerTextSearchFactory.Params

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.structure.service.Service

Service.DirectoryService<I>, Service.Exceptions, Service.ServiceCallContext, Service.ServiceFactory<I,R>, Service.Type

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Fields inherited from class org.apache.tinkerpop.gremlin.tinkergraph.services.TinkerServiceRegistry.TinkerServiceFactory

describeParams, graph, name, requirements

Constructor Summary

Constructors

Constructor and Description
TinkerTextSearchFactory(TinkerGraph graph)

Method Summary

Modifier and Type	Method and Description
void	close() Services can implement cleanup/shutdown procedures here.
Service<I,R>	createService(boolean isStart, Map params) Create a Service call instance.
Map	describeParams() Return a description of any service call parameters.
CloseableIterator<R>	execute(Service.ServiceCallContext ctx, Map params) Execute a Start service call.
Set<Service.Type>	getSupportedTypes() Get the execution modes that it supports.
Service.Type	getType() Return the Service.Type of service call.

Methods inherited from class org.apache.tinkerpop.gremlin.tinkergraph.services.TinkerServiceRegistry.TinkerServiceFactory

addDescribeParams, addRequirements, getName, getRequirements

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.service.Service

execute, execute, getMaxBarrierSize, getRequirements, isBarrier, isStart, isStreaming

Methods inherited from interface org.apache.tinkerpop.gremlin.structure.service.Service.ServiceFactory

getRequirementsByType

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

TinkerTextSearchFactory

public TinkerTextSearchFactory(TinkerGraph graph)

Method Detail

getType

public Service.Type getType()

Description copied from interface: Service

Return the Service.Type of service call.

Specified by:

getType in interface Service<I,R>

describeParams

public Map describeParams()

Description copied from interface: Service.ServiceFactory

Return a description of any service call parameters.

Specified by:

describeParams in interface Service.ServiceFactory<I,R>

Overrides:

describeParams in class TinkerServiceRegistry.TinkerServiceFactory<I,R>

getSupportedTypes

public Set<Service.Type> getSupportedTypes()

Description copied from interface: Service.ServiceFactory

Get the execution modes that it supports.

Specified by:

getSupportedTypes in interface Service.ServiceFactory<I,R>

createService

public Service<I,R> createService(boolean isStart,
                                  Map params)

Description copied from interface: Service.ServiceFactory

Create a Service call instance.

Specified by:

createService in interface Service.ServiceFactory<I,R>

Parameters:

isStart - true if the call is being used to start a traversal

params - the static params provided to service call (if any)

Returns:

the service call instance

execute

public CloseableIterator<R> execute(Service.ServiceCallContext ctx,
                                    Map params)

Description copied from interface: Service

Execute a Start service call.

Specified by:

execute in interface Service<I,R>

close

public void close()

Description copied from interface: Service

Services can implement cleanup/shutdown procedures here.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Service<I,R>

Specified by:

close in interface Service.ServiceFactory<I,R>