org.apache.asterix.metadata.external

Interface IAdapterFactory

All Superinterfaces:

Serializable

All Known Subinterfaces:

IFeedAdapterFactory, ITypedAdapterFactory

All Known Implementing Classes:

FieldExtractingAdapterFactory, PKGeneratingAdapterFactory

public interface IAdapterFactory
extends Serializable

Base interface for IGenericDatasetAdapterFactory and ITypedDatasetAdapterFactory. Acts as a marker interface indicating that the implementation provides functionality for creating an adapter.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IAdapterFactory.SupportedOperation

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_TYPE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(Map<String,String> configuration, ARecordType outputType)
IDatasourceAdapter	createAdapter(org.apache.hyracks.api.context.IHyracksTaskContext ctx, int partition) Creates an instance of IDatasourceAdapter.
ARecordType	getAdapterOutputType() Gets the record type associated with the output of the adapter
String	getName() Returns the display name corresponding to the Adapter type that is created by the factory.
org.apache.hyracks.algebricks.common.constraints.AlgebricksPartitionConstraint	getPartitionConstraint() Gets a list of partition constraints.
IAdapterFactory.SupportedOperation	getSupportedOperations() Returns the type of adapter indicating if the adapter can be used for reading from an external data source or writing to an external data source or can be used for both purposes.

Field Detail

KEY_TYPE_NAME

static final String KEY_TYPE_NAME

See Also:

Constant Field Values

Method Detail

getSupportedOperations

IAdapterFactory.SupportedOperation getSupportedOperations()

Returns the type of adapter indicating if the adapter can be used for reading from an external data source or writing to an external data source or can be used for both purposes.

Returns:

See Also:

IAdapterFactory.SupportedOperation

getName

String getName()

Returns the display name corresponding to the Adapter type that is created by the factory.

Returns:

the display name

getPartitionConstraint

org.apache.hyracks.algebricks.common.constraints.AlgebricksPartitionConstraint getPartitionConstraint()
                                                                                                      throws Exception

Gets a list of partition constraints. A partition constraint can be a requirement to execute at a particular location or could be cardinality constraints indicating the number of instances that need to run in parallel. example, a IDatasourceAdapter implementation written for data residing on the local file system of a node cannot run on any other node and thus has a location partition constraint. The location partition constraint can be expressed as a node IP address or a node controller id. In the former case, the IP address is translated to a node controller id running on the node with the given IP address.

Throws:

Exception

createAdapter

IDatasourceAdapter createAdapter(org.apache.hyracks.api.context.IHyracksTaskContext ctx,
                               int partition)
                                 throws Exception

Creates an instance of IDatasourceAdapter.

Parameters:

HyracksTaskContext -

partition -

Returns:

An instance of IDatasourceAdapter.

Throws:

Exception

configure

void configure(Map<String,String> configuration,
             ARecordType outputType)
               throws Exception

Parameters:

configuration -

outputType -

Throws:

Exception

getAdapterOutputType

ARecordType getAdapterOutputType()

Gets the record type associated with the output of the adapter

Returns: