AdaptorTap (Cascading 4.0.0-wip-70)

java.lang.Object
- cascading.tap.Tap<TConfig,TInput,TOutput>
- - cascading.tap.AdaptorTap<TConfig,TInput,TOutput,OConfig,OInput,OOutput>

All Implemented Interfaces:

FlowElement, ScopedElement, Traceable, java.io.Serializable

Direct Known Subclasses:

FileAdaptorTap
```
public class AdaptorTap<TConfig,TInput,TOutput,OConfig,OInput,OOutput>
extends Tap<TConfig,TInput,TOutput>
```
Class AdaptorTap wraps a given Tap instance, delegating all calls to the original. In addition, AdaptorTap implementations must provide Function implementations that will adapt one Config and FlowProcess type from the current platform types to the underlying Tap platform types.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.function.Function<TConfig,OConfig>`	`configProvider`
`protected Tap<OConfig,OInput,OOutput>`	`original`
`protected java.util.function.Function<FlowProcess<? extends TConfig>,FlowProcess<? extends OConfig>>`	`processProvider`

Constructor Summary

Constructors
Constructor and Description
`AdaptorTap(Tap<OConfig,OInput,OOutput> original, java.util.function.Function<FlowProcess<? extends TConfig>,FlowProcess<? extends OConfig>> processProvider, java.util.function.Function<TConfig,OConfig> configProvider)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`commitResource(TConfig conf)` Method commitResource allows the underlying resource to be notified when all write processing is successful so that any additional cleanup or processing may be completed.
`boolean`	`createResource(FlowProcess<? extends TConfig> flowProcess)` Method createResource creates the underlying resource.
`boolean`	`createResource(TConfig conf)` Method createResource creates the underlying resource.
`boolean`	`deleteResource(FlowProcess<? extends TConfig> flowProcess)` Method deleteResource deletes the resource represented by this instance.
`boolean`	`deleteResource(TConfig conf)` Method deleteResource deletes the resource represented by this instance.
`boolean`	`equals(java.lang.Object object)`
`void`	`flowConfInit(Flow<TConfig> flow)` Method flowInit allows this Tap instance to initialize itself in context of the given `Flow` instance.
`ConfigDef`	`getConfigDef()` Returns a `ConfigDef` instance that allows for local properties to be set and made available via a resulting `FlowProcess` instance when the tap is invoked.
`java.lang.String`	`getFullIdentifier(FlowProcess<? extends TConfig> flowProcess)` Method getFullIdentifier returns a fully qualified resource identifier.
`java.lang.String`	`getFullIdentifier(TConfig conf)` Method getFullIdentifier returns a fully qualified resource identifier.
`java.lang.String`	`getIdentifier()` Method getIdentifier returns a String representing the resource this Tap instance represents.
`long`	`getModifiedTime(FlowProcess<? extends TConfig> flowProcess)` Method getModifiedTime returns the date this resource was last modified.
`long`	`getModifiedTime(TConfig conf)` Method getModifiedTime returns the date this resource was last modified.
`ConfigDef`	`getNodeConfigDef()` Returns a `ConfigDef` instance that allows for process level properties to be set and made available via a resulting `FlowProcess` instance when the tap is invoked.
`Tap<OConfig,OInput,OOutput>`	`getOriginal()`
`Scheme<TConfig,TInput,TOutput,?,?>`	`getScheme()` Method getScheme returns the scheme of this Tap object.
`Fields`	`getSinkFields()` Method getSinkFields returns the sinkFields of this Tap object.
`SinkMode`	`getSinkMode()` Method getSinkMode returns the `SinkMode` }of this Tap object.
`Fields`	`getSourceFields()` Method getSourceFields returns the sourceFields of this Tap object.
`ConfigDef`	`getStepConfigDef()` Returns a `ConfigDef` instance that allows for process level properties to be set and made available via a resulting `FlowProcess` instance when the tap is invoked.
`java.lang.String`	`getTrace()` Method getTrace returns a String that pinpoints the caller that created this instance.
`boolean`	`hasConfigDef()` Returns `true` if there are properties in the configDef instance.
`int`	`hashCode()`
`boolean`	`hasNodeConfigDef()` Returns `true` if there are properties in the nodeConfigDef instance.
`boolean`	`hasStepConfigDef()` Returns `true` if there are properties in the stepConfigDef instance.
`boolean`	`isKeep()` Method isKeep indicates whether the resource represented by this instance should be kept if it already exists when the Flow is started.
`boolean`	`isReplace()` Method isReplace indicates whether the resource represented by this instance should be deleted if it already exists when the Flow is started.
`boolean`	`isSink()` Method isSink returns true if this Tap instance can be used as a sink.
`boolean`	`isSource()` Method isSource returns true if this Tap instance can be used as a source.
`boolean`	`isTemporary()` Method isTemporary returns true if this Tap is temporary (used for intermediate results).
`boolean`	`isUpdate()` Method isUpdate indicates whether the resource represented by this instance should be updated if it already exists.
`TupleEntryIterator`	`openForRead(FlowProcess<? extends TConfig> flowProcess)` Method openForRead opens the resource represented by this Tap instance for reading.
`TupleEntryIterator`	`openForRead(FlowProcess<? extends TConfig> flowProcess, TInput input)` Method openForRead opens the resource represented by this Tap instance for reading.
`TupleEntryCollector`	`openForWrite(FlowProcess<? extends TConfig> flowProcess)` Method openForWrite opens the resource represented by this Tap instance for writing.
`TupleEntryCollector`	`openForWrite(FlowProcess<? extends TConfig> flowProcess, TOutput output)` Method openForWrite opens the resource represented by this Tap instance for writing.
`Scope`	`outgoingScopeFor(java.util.Set<Scope> incomingScopes)` Method outgoingScopeFor returns the Scope this FlowElement hands off to the next FlowElement.
`boolean`	`prepareResourceForRead(TConfig conf)` Method prepareResourceForRead allows the underlying resource to be notified when reading will begin.
`boolean`	`prepareResourceForWrite(TConfig conf)` Method prepareResourceForWrite allows the underlying resource to be notified when writing will begin.
`void`	`presentSinkFields(FlowProcess<? extends TConfig> flowProcess, Fields fields)`
`void`	`presentSourceFields(FlowProcess<? extends TConfig> flowProcess, Fields fields)`
`Fields`	`resolveIncomingOperationArgumentFields(Scope incomingScope)` Method resolveIncomingOperationArgumentFields returns the Fields outgoing from the previous FlowElement that are consumable by this FlowElement when preparing Operation arguments.
`Fields`	`resolveIncomingOperationPassThroughFields(Scope incomingScope)` Method resolveIncomingOperationPassThroughFields returns the Fields outgoing from the previous FlowElement that are consumable by this FlowElement when preparing the Pipe outgoing tuple.
`boolean`	`resourceExists(FlowProcess<? extends TConfig> flowProcess)` Method resourceExists returns true if the path represented by this instance exists.
`boolean`	`resourceExists(TConfig conf)` Method resourceExists returns true if the path represented by this instance exists.
`Fields`	`retrieveSinkFields(FlowProcess<? extends TConfig> flowProcess)` A hook for allowing a Scheme to lazily retrieve its sink fields.
`Fields`	`retrieveSourceFields(FlowProcess<? extends TConfig> flowProcess)` A hook for allowing a Scheme to lazily retrieve its source fields.
`boolean`	`rollbackResource(TConfig conf)` Method rollbackResource allows the underlying resource to be notified when any write processing has failed or was stopped so that any cleanup may be started.
`protected void`	`setOriginal(Tap<OConfig,OInput,OOutput> original)`
`void`	`sinkConfInit(FlowProcess<? extends TConfig> flowProcess, TConfig conf)` Method sinkConfInit initializes this instance as a sink.
`void`	`sourceConfInit(FlowProcess<? extends TConfig> flowProcess, TConfig conf)` Method sourceConfInit initializes this instance as a source.
`java.lang.String`	`toString()`

Methods inherited from class cascading.tap.Tap
entryStream, entryStream, entryStreamCopy, entryStreamCopy, id, openForReadUnchecked, setScheme, spliterator, splititerator, taps, tupleStream, tupleStream, tupleStreamCopy, tupleStreamCopy

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - original
```
protected Tap<OConfig,OInput,OOutput> original
```
  - processProvider
```
protected java.util.function.Function<FlowProcess<? extends TConfig>,FlowProcess<? extends OConfig>> processProvider
```
  - configProvider
```
protected java.util.function.Function<TConfig,OConfig> configProvider
```
- Constructor Detail
  - AdaptorTap
```
@ConstructorProperties(value={"original","processProvider","configProvider"})
public AdaptorTap(Tap<OConfig,OInput,OOutput> original,
                                                                                                java.util.function.Function<FlowProcess<? extends TConfig>,FlowProcess<? extends OConfig>> processProvider,
                                                                                                java.util.function.Function<TConfig,OConfig> configProvider)
```
- Method Detail
  - getOriginal
```
public Tap<OConfig,OInput,OOutput> getOriginal()
```
  - setOriginal
```
protected void setOriginal(Tap<OConfig,OInput,OOutput> original)
```
  - getScheme
```
public Scheme<TConfig,TInput,TOutput,?,?> getScheme()
```
    Description copied from class: Tap
    
    Method getScheme returns the scheme of this Tap object.
    
    Overrides:
    
    getScheme in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    the scheme (type Scheme) of this Tap object.
  - getTrace
```
public java.lang.String getTrace()
```
    Description copied from interface: Traceable
    
    Method getTrace returns a String that pinpoints the caller that created this instance.
    
    Specified by:
    
    getTrace in interface Traceable
    
    Overrides:
    
    getTrace in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    String
  - flowConfInit
```
public void flowConfInit(Flow<TConfig> flow)
```
    Description copied from class: Tap
    
    Method flowInit allows this Tap instance to initialize itself in context of the given Flow instance. This method is guaranteed to be called before the Flow is started and the FlowListener.onStarting(cascading.flow.Flow) event is fired.
    This method will be called once per Flow, and before Tap.sourceConfInit(cascading.flow.FlowProcess, Object) and Tap.sinkConfInit(cascading.flow.FlowProcess, Object) methods.
    
    Overrides:
    
    flowConfInit in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    flow - of type Flow
  - sourceConfInit
```
public void sourceConfInit(FlowProcess<? extends TConfig> flowProcess,
                           TConfig conf)
```
    Description copied from class: Tap
    
    Method sourceConfInit initializes this instance as a source.
    This method maybe called more than once if this Tap instance is used outside the scope of a Flow instance or if it participates in multiple times in a given Flow or across different Flows in a Cascade.
    In the context of a Flow, it will be called after FlowListener.onStarting(cascading.flow.Flow)
    Note that no resources or services should be modified by this method.
    
    Overrides:
    
    sourceConfInit in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    flowProcess - of type FlowProcess
    
    conf - of type Config
  - sinkConfInit
```
public void sinkConfInit(FlowProcess<? extends TConfig> flowProcess,
                         TConfig conf)
```
    Description copied from class: Tap
    
    Method sinkConfInit initializes this instance as a sink.
    This method maybe called more than once if this Tap instance is used outside the scope of a Flow instance or if it participates in multiple times in a given Flow or across different Flows in a Cascade.
    Note this method will be called in context of this Tap being used as a traditional 'sink' and as a 'trap'.
    In the context of a Flow, it will be called after FlowListener.onStarting(cascading.flow.Flow)
    Note that no resources or services should be modified by this method. If this Tap instance returns true for Tap.isReplace(), then Tap.deleteResource(Object) will be called by the parent Flow.
    
    Overrides:
    
    sinkConfInit in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    flowProcess - of type FlowProcess
    
    conf - of type Config
  - getIdentifier
```
public java.lang.String getIdentifier()
```
    Description copied from class: Tap
    
    Method getIdentifier returns a String representing the resource this Tap instance represents.
    Often, if the tap accesses a filesystem, the identifier is nothing more than the path to the file or directory. In other cases it may be a an URL or URI representing a connection string or remote resource.
    Any two Tap instances having the same value for the identifier are considered equal.
    
    Specified by:
    
    getIdentifier in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    String
  - getSourceFields
```
public Fields getSourceFields()
```
    Description copied from class: Tap
    
    Method getSourceFields returns the sourceFields of this Tap object.
    
    Overrides:
    
    getSourceFields in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    the sourceFields (type Fields) of this Tap object.
  - getSinkFields
```
public Fields getSinkFields()
```
    Description copied from class: Tap
    
    Method getSinkFields returns the sinkFields of this Tap object.
    
    Overrides:
    
    getSinkFields in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    the sinkFields (type Fields) of this Tap object.
  - openForRead
```
public TupleEntryIterator openForRead(FlowProcess<? extends TConfig> flowProcess,
                                      TInput input)
                               throws java.io.IOException
```
    Description copied from class: Tap
    
    Method openForRead opens the resource represented by this Tap instance for reading.
    input value may be null, if so, sub-classes must inquire with the underlying Scheme via Scheme.sourceConfInit(cascading.flow.FlowProcess, Tap, Object) to get the proper input type and instantiate it before calling super.openForRead().
    Note the returned iterator will return the same instance of TupleEntry on every call, thus a copy must be made of either the TupleEntry or the underlying Tuple instance if they are to be stored in a Collection.
    
    Specified by:
    
    openForRead in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    flowProcess - of type FlowProcess
    
    input - of type Input
    
    Returns:
    
    TupleEntryIterator
    
    Throws:
    
    java.io.IOException - when the resource cannot be opened
  - openForRead
```
public TupleEntryIterator openForRead(FlowProcess<? extends TConfig> flowProcess)
                               throws java.io.IOException
```
    Description copied from class: Tap
    
    Method openForRead opens the resource represented by this Tap instance for reading.
    Note the returned iterator will return the same instance of TupleEntry on every call, thus a copy must be made of either the TupleEntry or the underlying Tuple instance if they are to be stored in a Collection.
    
    Overrides:
    
    openForRead in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    flowProcess - of type FlowProcess
    
    Returns:
    
    TupleEntryIterator
    
    Throws:
    
    java.io.IOException - when the resource cannot be opened
  - openForWrite
```
public TupleEntryCollector openForWrite(FlowProcess<? extends TConfig> flowProcess,
                                        TOutput output)
                                 throws java.io.IOException
```
    Description copied from class: Tap
    
    Method openForWrite opens the resource represented by this Tap instance for writing.
    This method is used internally and does not honor the SinkMode setting. If SinkMode is SinkMode.REPLACE, this call may fail. See Tap.openForWrite(cascading.flow.FlowProcess).
    output value may be null, if so, sub-classes must inquire with the underlying Scheme via Scheme.sinkConfInit(cascading.flow.FlowProcess, Tap, Object) to get the proper output type and instantiate it before calling super.openForWrite().
    
    Specified by:
    
    openForWrite in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    flowProcess - of type FlowProcess
    
    output - of type Output
    
    Returns:
    
    TupleEntryCollector
    
    Throws:
    
    java.io.IOException - when the resource cannot be opened
  - openForWrite
```
public TupleEntryCollector openForWrite(FlowProcess<? extends TConfig> flowProcess)
                                 throws java.io.IOException
```
    Description copied from class: Tap
    
    Method openForWrite opens the resource represented by this Tap instance for writing.
    This method is for user application use and does honor the SinkMode.REPLACE settings. That is, if SinkMode is set to SinkMode.REPLACE the underlying resource will be deleted.
    Note if SinkMode.UPDATE is set, the resource will not be deleted.
    
    Overrides:
    
    openForWrite in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    flowProcess - of type FlowProcess
    
    Returns:
    
    TupleEntryCollector
    
    Throws:
    
    java.io.IOException - when the resource cannot be opened
  - outgoingScopeFor
```
public Scope outgoingScopeFor(java.util.Set<Scope> incomingScopes)
```
    Description copied from interface: ScopedElement
    
    Method outgoingScopeFor returns the Scope this FlowElement hands off to the next FlowElement.
    
    Specified by:
    
    outgoingScopeFor in interface ScopedElement
    
    Overrides:
    
    outgoingScopeFor in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    incomingScopes - of type Set
    
    Returns:
    
    Scope
  - retrieveSourceFields
```
public Fields retrieveSourceFields(FlowProcess<? extends TConfig> flowProcess)
```
    Description copied from class: Tap
    
    A hook for allowing a Scheme to lazily retrieve its source fields.
    
    Overrides:
    
    retrieveSourceFields in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    flowProcess - of type FlowProcess
    
    Returns:
    
    the found Fields
  - presentSourceFields
```
public void presentSourceFields(FlowProcess<? extends TConfig> flowProcess,
                                Fields fields)
```
    Overrides:
    
    presentSourceFields in class Tap<TConfig,TInput,TOutput>
  - retrieveSinkFields
```
public Fields retrieveSinkFields(FlowProcess<? extends TConfig> flowProcess)
```
    Description copied from class: Tap
    
    A hook for allowing a Scheme to lazily retrieve its sink fields.
    
    Overrides:
    
    retrieveSinkFields in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    flowProcess - of type FlowProcess
    
    Returns:
    
    the found Fields
  - presentSinkFields
```
public void presentSinkFields(FlowProcess<? extends TConfig> flowProcess,
                              Fields fields)
```
    Overrides:
    
    presentSinkFields in class Tap<TConfig,TInput,TOutput>
  - resolveIncomingOperationArgumentFields
```
public Fields resolveIncomingOperationArgumentFields(Scope incomingScope)
```
    Description copied from interface: ScopedElement
    
    Method resolveIncomingOperationArgumentFields returns the Fields outgoing from the previous FlowElement that are consumable by this FlowElement when preparing Operation arguments.
    
    Specified by:
    
    resolveIncomingOperationArgumentFields in interface ScopedElement
    
    Overrides:
    
    resolveIncomingOperationArgumentFields in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    incomingScope - of type Scope
    
    Returns:
    
    Fields
  - resolveIncomingOperationPassThroughFields
```
public Fields resolveIncomingOperationPassThroughFields(Scope incomingScope)
```
    Description copied from interface: ScopedElement
    
    Method resolveIncomingOperationPassThroughFields returns the Fields outgoing from the previous FlowElement that are consumable by this FlowElement when preparing the Pipe outgoing tuple.
    
    Specified by:
    
    resolveIncomingOperationPassThroughFields in interface ScopedElement
    
    Overrides:
    
    resolveIncomingOperationPassThroughFields in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    incomingScope - of type Scope
    
    Returns:
    
    Fields
  - getFullIdentifier
```
public java.lang.String getFullIdentifier(FlowProcess<? extends TConfig> flowProcess)
```
    Description copied from class: Tap
    
    Method getFullIdentifier returns a fully qualified resource identifier.
    
    Overrides:
    
    getFullIdentifier in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    flowProcess - of type FlowProcess
    
    Returns:
    
    String
  - getFullIdentifier
```
public java.lang.String getFullIdentifier(TConfig conf)
```
    Description copied from class: Tap
    
    Method getFullIdentifier returns a fully qualified resource identifier.
    
    Overrides:
    
    getFullIdentifier in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    conf - of type Config
    
    Returns:
    
    String
  - createResource
```
public boolean createResource(FlowProcess<? extends TConfig> flowProcess)
                       throws java.io.IOException
```
    Description copied from class: Tap
    
    Method createResource creates the underlying resource.
    
    Overrides:
    
    createResource in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    flowProcess - of type FlowProcess
    
    Returns:
    
    boolean
    
    Throws:
    
    java.io.IOException - when there is an error making directories
  - createResource
```
public boolean createResource(TConfig conf)
                       throws java.io.IOException
```
    Description copied from class: Tap
    
    Method createResource creates the underlying resource.
    
    Specified by:
    
    createResource in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    conf - of type Config
    
    Returns:
    
    boolean
    
    Throws:
    
    java.io.IOException - when there is an error making directories
  - deleteResource
```
public boolean deleteResource(FlowProcess<? extends TConfig> flowProcess)
                       throws java.io.IOException
```
    Description copied from class: Tap
    
    Method deleteResource deletes the resource represented by this instance.
    
    Overrides:
    
    deleteResource in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    flowProcess - of type FlowProcess
    
    Returns:
    
    boolean
    
    Throws:
    
    java.io.IOException - when the resource cannot be deleted
  - deleteResource
```
public boolean deleteResource(TConfig conf)
                       throws java.io.IOException
```
    Description copied from class: Tap
    
    Method deleteResource deletes the resource represented by this instance.
    
    Specified by:
    
    deleteResource in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    conf - of type Config
    
    Returns:
    
    boolean
    
    Throws:
    
    java.io.IOException - when the resource cannot be deleted
  - prepareResourceForRead
```
public boolean prepareResourceForRead(TConfig conf)
                               throws java.io.IOException
```
    Description copied from class: Tap
    
    Method prepareResourceForRead allows the underlying resource to be notified when reading will begin.
    This method will be called client side so that any remote or external resources can be initialized.
    If this method returns false, an exception will be thrown halting the current Flow.
    In most cases, resource initialization should happen in the Tap.openForRead(FlowProcess, Object) method.
    This allows for initialization of cluster side resources, like a JDBC driver used to read data from a database, that cannot be passed client to cluster.
    
    Overrides:
    
    prepareResourceForRead in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    conf - of type Config
    
    Returns:
    
    returns true if successful
    
    Throws:
    
    java.io.IOException
  - prepareResourceForWrite
```
public boolean prepareResourceForWrite(TConfig conf)
                                throws java.io.IOException
```
    Description copied from class: Tap
    
    Method prepareResourceForWrite allows the underlying resource to be notified when writing will begin.
    This method will be called once client side so that any remote or external resources can be initialized.
    If this method returns false, an exception will be thrown halting the current Flow.
    In most cases, resource initialization should happen in the Tap.openForWrite(FlowProcess, Object) method.
    This allows for initialization of cluster side resources, like a JDBC driver used to write data to a database, that cannot be passed client to cluster.
    In the above JDBC example, overriding this method will allow for testing for the existence of and/or creating a remote table used by all individual cluster side tasks.
    
    Overrides:
    
    prepareResourceForWrite in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    conf - of type Config
    
    Returns:
    
    returns true if successful
    
    Throws:
    
    java.io.IOException
  - commitResource
```
public boolean commitResource(TConfig conf)
                       throws java.io.IOException
```
    Description copied from class: Tap
    
    Method commitResource allows the underlying resource to be notified when all write processing is successful so that any additional cleanup or processing may be completed.
    See Tap.rollbackResource(Object) to handle cleanup in the face of failures.
    This method is invoked once client side and not in the cluster, if any.
    If other sink Tap instance in a given Flow fail on commitResource after called on this instance, rollbackResource will not be called.
    
    Overrides:
    
    commitResource in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    conf - of type Config
    
    Returns:
    
    returns true if successful
    
    Throws:
    
    java.io.IOException
  - rollbackResource
```
public boolean rollbackResource(TConfig conf)
                         throws java.io.IOException
```
    Description copied from class: Tap
    
    Method rollbackResource allows the underlying resource to be notified when any write processing has failed or was stopped so that any cleanup may be started.
    See Tap.commitResource(Object) to handle cleanup when the write has successfully completed.
    This method is invoked once client side and not in the cluster, if any.
    
    Overrides:
    
    rollbackResource in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    conf - of type Config
    
    Returns:
    
    returns true if successful
    
    Throws:
    
    java.io.IOException
  - resourceExists
```
public boolean resourceExists(FlowProcess<? extends TConfig> flowProcess)
                       throws java.io.IOException
```
    Description copied from class: Tap
    
    Method resourceExists returns true if the path represented by this instance exists.
    
    Overrides:
    
    resourceExists in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    flowProcess - of type FlowProcess
    
    Returns:
    
    true if the underlying resource already exists
    
    Throws:
    
    java.io.IOException - when the status cannot be determined
  - resourceExists
```
public boolean resourceExists(TConfig conf)
                       throws java.io.IOException
```
    Description copied from class: Tap
    
    Method resourceExists returns true if the path represented by this instance exists.
    
    Specified by:
    
    resourceExists in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    conf - of type Config
    
    Returns:
    
    true if the underlying resource already exists
    
    Throws:
    
    java.io.IOException - when the status cannot be determined
  - getModifiedTime
```
public long getModifiedTime(FlowProcess<? extends TConfig> flowProcess)
                     throws java.io.IOException
```
    Description copied from class: Tap
    
    Method getModifiedTime returns the date this resource was last modified.
    If the resource does not exist, returns zero (0).
    If the resource is continuous, returns Long.MAX_VALUE.
    
    Overrides:
    
    getModifiedTime in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    flowProcess - of type FlowProcess
    
    Returns:
    
    The date this resource was last modified.
    
    Throws:
    
    java.io.IOException
  - getModifiedTime
```
public long getModifiedTime(TConfig conf)
                     throws java.io.IOException
```
    Description copied from class: Tap
    
    Method getModifiedTime returns the date this resource was last modified.
    If the resource does not exist, returns zero (0).
    If the resource is continuous, returns Long.MAX_VALUE.
    
    Specified by:
    
    getModifiedTime in class Tap<TConfig,TInput,TOutput>
    
    Parameters:
    
    conf - of type Config
    
    Returns:
    
    The date this resource was last modified.
    
    Throws:
    
    java.io.IOException
  - getSinkMode
```
public SinkMode getSinkMode()
```
    Description copied from class: Tap
    
    Method getSinkMode returns the SinkMode }of this Tap object.
    
    Overrides:
    
    getSinkMode in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    the sinkMode (type SinkMode) of this Tap object.
  - isKeep
```
public boolean isKeep()
```
    Description copied from class: Tap
    
    Method isKeep indicates whether the resource represented by this instance should be kept if it already exists when the Flow is started.
    
    Overrides:
    
    isKeep in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    boolean
  - isReplace
```
public boolean isReplace()
```
    Description copied from class: Tap
    
    Method isReplace indicates whether the resource represented by this instance should be deleted if it already exists when the Flow is started.
    
    Overrides:
    
    isReplace in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    boolean
  - isUpdate
```
public boolean isUpdate()
```
    Description copied from class: Tap
    
    Method isUpdate indicates whether the resource represented by this instance should be updated if it already exists. Otherwise a new resource will be created, via Tap.createResource(Object), when the Flow is started.
    
    Overrides:
    
    isUpdate in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    boolean
  - isSink
```
public boolean isSink()
```
    Description copied from class: Tap
    
    Method isSink returns true if this Tap instance can be used as a sink.
    
    Overrides:
    
    isSink in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    boolean
  - isSource
```
public boolean isSource()
```
    Description copied from class: Tap
    
    Method isSource returns true if this Tap instance can be used as a source.
    
    Overrides:
    
    isSource in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    boolean
  - isTemporary
```
public boolean isTemporary()
```
    Description copied from class: Tap
    
    Method isTemporary returns true if this Tap is temporary (used for intermediate results).
    
    Overrides:
    
    isTemporary in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    the temporary (type boolean) of this Tap object.
  - getConfigDef
```
public ConfigDef getConfigDef()
```
    Description copied from class: Tap
    
    Returns a ConfigDef instance that allows for local properties to be set and made available via a resulting FlowProcess instance when the tap is invoked.
    Any properties set on the configDef will not show up in any Flow or FlowStep process level configuration, but will override any of those values as seen by the current Tap instance method call where a FlowProcess is provided except for the Tap.sourceConfInit(cascading.flow.FlowProcess, Object) and Tap.sinkConfInit(cascading.flow.FlowProcess, Object) methods.
    That is, the *confInit methods are called before any ConfigDef is applied, so any values placed into a ConfigDef instance will not be visible to them.
    
    Specified by:
    
    getConfigDef in interface ScopedElement
    
    Overrides:
    
    getConfigDef in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    an instance of ConfigDef
  - hasConfigDef
```
public boolean hasConfigDef()
```
    Description copied from class: Tap
    
    Returns true if there are properties in the configDef instance.
    
    Specified by:
    
    hasConfigDef in interface ScopedElement
    
    Overrides:
    
    hasConfigDef in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    true if there are configDef properties
  - getNodeConfigDef
```
public ConfigDef getNodeConfigDef()
```
    Description copied from class: Tap
    
    Returns a ConfigDef instance that allows for process level properties to be set and made available via a resulting FlowProcess instance when the tap is invoked.
    Any properties set on the nodeConfigDef will not show up in any Flow configuration, but will show up in the current process FlowNode (in Apache Tez the Vertex configuration). Any value set in the nodeConfigDef will be overridden by the pipe local #getConfigDef instance.
    Use this method to tweak properties in the process node this tap instance is planned into.
    
    Specified by:
    
    getNodeConfigDef in interface ScopedElement
    
    Overrides:
    
    getNodeConfigDef in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    an instance of ConfigDef
  - hasNodeConfigDef
```
public boolean hasNodeConfigDef()
```
    Description copied from class: Tap
    
    Returns true if there are properties in the nodeConfigDef instance.
    
    Specified by:
    
    hasNodeConfigDef in interface ScopedElement
    
    Overrides:
    
    hasNodeConfigDef in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    true if there are nodeConfigDef properties
  - getStepConfigDef
```
public ConfigDef getStepConfigDef()
```
    Description copied from class: Tap
    
    Returns a ConfigDef instance that allows for process level properties to be set and made available via a resulting FlowProcess instance when the tap is invoked.
    Any properties set on the stepConfigDef will not show up in any Flow configuration, but will show up in the current process FlowStep (in Hadoop the MapReduce jobconf). Any value set in the stepConfigDef will be overridden by the tap local #getConfigDef instance.
    Use this method to tweak properties in the process step this tap instance is planned into.
    Note the *confInit methods are called before any ConfigDef is applied, so any values placed into a ConfigDef instance will not be visible to them.
    
    Specified by:
    
    getStepConfigDef in interface ScopedElement
    
    Overrides:
    
    getStepConfigDef in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    an instance of ConfigDef
  - hasStepConfigDef
```
public boolean hasStepConfigDef()
```
    Description copied from class: Tap
    
    Returns true if there are properties in the stepConfigDef instance.
    
    Specified by:
    
    hasStepConfigDef in interface ScopedElement
    
    Overrides:
    
    hasStepConfigDef in class Tap<TConfig,TInput,TOutput>
    
    Returns:
    
    true if there are stepConfigDef properties
  - equals
```
public boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class Tap<TConfig,TInput,TOutput>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Tap<TConfig,TInput,TOutput>
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class Tap<TConfig,TInput,TOutput>

Class AdaptorTap<TConfig,TInput,TOutput,OConfig,OInput,OOutput>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class cascading.tap.Tap

Methods inherited from class java.lang.Object

Field Detail

original

processProvider

configProvider

Constructor Detail

AdaptorTap

Method Detail

getOriginal

setOriginal

getScheme

getTrace

flowConfInit

sourceConfInit

sinkConfInit

getIdentifier

getSourceFields

getSinkFields

openForRead

openForRead

openForWrite

openForWrite

outgoingScopeFor

retrieveSourceFields

presentSourceFields

retrieveSinkFields

presentSinkFields

resolveIncomingOperationArgumentFields

resolveIncomingOperationPassThroughFields

getFullIdentifier

getFullIdentifier

createResource

createResource

deleteResource

deleteResource

prepareResourceForRead

prepareResourceForWrite

commitResource

rollbackResource

resourceExists

resourceExists

getModifiedTime

getModifiedTime

getSinkMode

isKeep

isReplace

isUpdate

isSink

isSource

isTemporary

getConfigDef

hasConfigDef

getNodeConfigDef

hasNodeConfigDef

getStepConfigDef

hasStepConfigDef

equals

hashCode

toString