forklift.source

Class LogicalSource

java.lang.Object

forklift.source.SourceI

forklift.source.LogicalSource

Direct Known Subclasses:

RoleInputSource

public abstract class LogicalSource
extends SourceI

A marker for sources that are not tied to a particular algorithmic implementation.

As a result, the determination of how to actually read from a particular logical source can be split between the source itself and some kind of context. Currently, the connector serves as the context for mapping a source.

A source that depends on what is being received rather than how it is being received is a good candidate for something that makes sense as a LogicalSource.

Nested Class Summary

Nested classes/interfaces inherited from class forklift.source.SourceI

SourceI.ExceptionalConsumer<I,E extends java.lang.Throwable>, SourceI.ExceptionalFunction<I,O,E extends java.lang.Throwable>, SourceI.SourceIHandler<OUT>

Constructor Summary

Constructors

Constructor and Description
LogicalSource()

Method Summary

Modifier and Type	Method and Description
abstract ActionSource	getActionSource(LogicalSourceContext mapper) Resolves this source to an action source, potentially using the given logical source context, if necessary.
boolean	isLogicalSource()

Methods inherited from class forklift.source.SourceI

accept, apply, getContextClass, onContextSet, setContextClass

Methods inherited from class java.lang.Object

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

Constructor Detail

LogicalSource

public LogicalSource()

Method Detail

isLogicalSource

public boolean isLogicalSource()

Specified by:

isLogicalSource in class SourceI

Returns:

whether or not this source needs to be resolved to an action source

getActionSource

public abstract ActionSource getActionSource(LogicalSourceContext mapper)

Resolves this source to an action source, potentially using the given logical source context, if necessary.

Parameters:

mapper - the logical source context that contains this source

Returns:

this source, as represented by an action source