InputData

java.lang.Object
- org.apache.hawq.pxf.api.utilities.InputData

Direct Known Subclasses:

ProtocolData
```
public class InputData
extends java.lang.Object
```
Common configuration available to all PXF plugins. Represents input data coming from client applications, such as Hawq.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`accessor`
`protected int`	`dataFragment`
`protected java.lang.String`	`dataSource`
`protected java.lang.String`	`filterString`
`protected boolean`	`filterStringValid`
`protected java.lang.String`	`fragmenter`
`protected byte[]`	`fragmentMetadata`
`static int`	`INVALID_SPLIT_IDX`
`protected java.lang.String`	`metadata`
`protected ColumnDescriptor`	`recordkeyColumn` The name of the recordkey column.
`protected java.lang.String`	`remoteLogin`
`protected java.lang.String`	`remoteSecret`
`protected java.util.Map<java.lang.String,java.lang.String>`	`requestParametersMap`
`protected java.lang.String`	`resolver`
`protected int`	`segmentId`
`protected boolean`	`threadSafe` When false the bridge has to run in synchronized mode.
`protected int`	`totalSegments`
`protected java.util.ArrayList<ColumnDescriptor>`	`tupleDescription`
`protected byte[]`	`userData`

Constructor Summary

Constructors
Constructor and Description

InputData()
Constructs an empty InputData

InputData(InputData copy)
Constructs an InputData from a copy.

Constructors
Constructor and Description
`InputData()` Constructs an empty InputData
`InputData(InputData copy)` Constructs an InputData from a copy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAccessor()` Returns the ClassName for the java class that was defined as Accessor.
`ColumnDescriptor`	`getColumn(int index)` Returns column index from tuple description.
`int`	`getColumns()` Returns the number of columns in tuple description.
`int`	`getDataFragment()` Returns a data fragment index.
`java.lang.String`	`getDataSource()` Returns the data source of the required resource (i.e a file path or a table name).
`java.lang.String`	`getFilterString()` Returns the filter string, `null` if #hasFilter is `false`.
`java.lang.String`	`getFragmenter()` Returns the ClassName for the java class that was defined as Fragmenter or null if no fragmenter was defined.
`byte[]`	`getFragmentMetadata()` The byte serialization of a data fragment.
`byte[]`	`getFragmentUserData()` Gets any custom user data that may have been passed from the fragmenter.
`java.lang.String`	`getLogin()` Returns the contents of pxf_remote_service_login set in Hawq.
`java.lang.String`	`getMetadata()` Returns the ClassName for the java class that was defined as Metadata or null if no metadata was defined.
`ColumnDescriptor`	`getRecordkeyColumn()` Returns the column descriptor of the recordkey column.
`java.lang.String`	`getResolver()` Returns the ClassName for the java class that was defined as Resolver.
`java.lang.String`	`getSecret()` Returns the contents of pxf_remote_service_secret set in Hawq.
`int`	`getSegmentId()` Returns the current segment ID in HAWQ.
`int`	`getTotalSegments()` Returns the number of segments in HAWQ.
`java.util.ArrayList<ColumnDescriptor>`	`getTupleDescription()` Returns tuple description.
`java.lang.String`	`getUserProperty(java.lang.String userProp)` Returns a user defined property.
`boolean`	`hasFilter()` Returns true if there is a filter string to parse.
`boolean`	`isThreadSafe()` Returns whether this request is thread safe.
`void`	`setDataSource(java.lang.String dataSource)` Sets the data source for the required resource.
`void`	`setFragmentMetadata(byte[] location)` Sets the byte serialization of a fragment meta data.
`void`	`setFragmentUserData(byte[] userData)` Sets any custom user data that needs to be shared across plugins.

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

- Field Detail
  - INVALID_SPLIT_IDX
```
public static final int INVALID_SPLIT_IDX
```
    See Also:
    
    Constant Field Values
  - requestParametersMap
```
protected java.util.Map<java.lang.String,java.lang.String> requestParametersMap
```
  - tupleDescription
```
protected java.util.ArrayList<ColumnDescriptor> tupleDescription
```
  - segmentId
```
protected int segmentId
```
  - totalSegments
```
protected int totalSegments
```
  - fragmentMetadata
```
protected byte[] fragmentMetadata
```
  - userData
```
protected byte[] userData
```
  - filterStringValid
```
protected boolean filterStringValid
```
  - filterString
```
protected java.lang.String filterString
```
  - dataSource
```
protected java.lang.String dataSource
```
  - accessor
```
protected java.lang.String accessor
```
  - resolver
```
protected java.lang.String resolver
```
  - fragmenter
```
protected java.lang.String fragmenter
```
  - metadata
```
protected java.lang.String metadata
```
  - remoteLogin
```
protected java.lang.String remoteLogin
```
  - remoteSecret
```
protected java.lang.String remoteSecret
```
  - dataFragment
```
protected int dataFragment
```
  - threadSafe
```
protected boolean threadSafe
```
    When false the bridge has to run in synchronized mode. default value - true.
  - recordkeyColumn
```
protected ColumnDescriptor recordkeyColumn
```
    The name of the recordkey column. It can appear in any location in the columns list. By specifying the recordkey column, the user declares that he is interested to receive for every record retrieved also the the recordkey in the database. The recordkey is present in HBase table (it is called rowkey), and in sequence files. When the HDFS storage element queried will not have a recordkey and the user will still specify it in the "create external table" statement, then the values for this field will be null. This field will always be the first field in the tuple returned.
- Constructor Detail
  - InputData
```
public InputData()
```
    Constructs an empty InputData
  - InputData
```
public InputData(InputData copy)
```
    Constructs an InputData from a copy. Used to create from an extending class.
    
    Parameters:
    
    copy - the input data to copy
- Method Detail
  - getUserProperty
```
public java.lang.String getUserProperty(java.lang.String userProp)
```
    Returns a user defined property.
    
    Parameters:
    
    userProp - the lookup user property
    
    Returns:
    
    property value as a String
  - setFragmentMetadata
```
public void setFragmentMetadata(byte[] location)
```
    Sets the byte serialization of a fragment meta data.
    
    Parameters:
    
    location - start, len, and location of the fragment
  - getFragmentMetadata
```
public byte[] getFragmentMetadata()
```
    The byte serialization of a data fragment.
    
    Returns:
    
    serialized fragment metadata
  - getFragmentUserData
```
public byte[] getFragmentUserData()
```
    Gets any custom user data that may have been passed from the fragmenter. Will mostly be used by the accessor or resolver.
    
    Returns:
    
    fragment user data
  - setFragmentUserData
```
public void setFragmentUserData(byte[] userData)
```
    Sets any custom user data that needs to be shared across plugins. Will mostly be set by the fragmenter.
    
    Parameters:
    
    userData - user data
  - getTotalSegments
```
public int getTotalSegments()
```
    Returns the number of segments in HAWQ.
    
    Returns:
    
    number of segments
  - getSegmentId
```
public int getSegmentId()
```
    Returns the current segment ID in HAWQ.
    
    Returns:
    
    current segment ID
  - hasFilter
```
public boolean hasFilter()
```
    Returns true if there is a filter string to parse.
    
    Returns:
    
    whether there is a filter string
  - getFilterString
```
public java.lang.String getFilterString()
```
    Returns the filter string, null if #hasFilter is false.
    
    Returns:
    
    the filter string or null
  - getTupleDescription
```
public java.util.ArrayList<ColumnDescriptor> getTupleDescription()
```
    Returns tuple description.
    
    Returns:
    
    tuple description
  - getColumns
```
public int getColumns()
```
    Returns the number of columns in tuple description.
    
    Returns:
    
    number of columns
  - getColumn
```
public ColumnDescriptor getColumn(int index)
```
    Returns column index from tuple description.
    
    Parameters:
    
    index - index of column
    
    Returns:
    
    column by index
  - getRecordkeyColumn
```
public ColumnDescriptor getRecordkeyColumn()
```
    Returns the column descriptor of the recordkey column. If the recordkey column was not specified by the user in the create table statement will return null.
    
    Returns:
    
    column of record key or null
  - getDataSource
```
public java.lang.String getDataSource()
```
    Returns the data source of the required resource (i.e a file path or a table name).
    
    Returns:
    
    data source
  - setDataSource
```
public void setDataSource(java.lang.String dataSource)
```
    Sets the data source for the required resource.
    
    Parameters:
    
    dataSource - data source to be set
  - getAccessor
```
public java.lang.String getAccessor()
```
    Returns the ClassName for the java class that was defined as Accessor.
    
    Returns:
    
    class name for Accessor
  - getResolver
```
public java.lang.String getResolver()
```
    Returns the ClassName for the java class that was defined as Resolver.
    
    Returns:
    
    class name for Resolver
  - getFragmenter
```
public java.lang.String getFragmenter()
```
    Returns the ClassName for the java class that was defined as Fragmenter or null if no fragmenter was defined.
    
    Returns:
    
    class name for Fragmenter or null
  - getMetadata
```
public java.lang.String getMetadata()
```
    Returns the ClassName for the java class that was defined as Metadata or null if no metadata was defined.
    
    Returns:
    
    class name for METADATA or null
  - getLogin
```
public java.lang.String getLogin()
```
    Returns the contents of pxf_remote_service_login set in Hawq. Should the user set it to an empty string this function will return null.
    
    Returns:
    
    remote login details if set, null otherwise
  - getSecret
```
public java.lang.String getSecret()
```
    Returns the contents of pxf_remote_service_secret set in Hawq. Should the user set it to an empty string this function will return null.
    
    Returns:
    
    remote password if set, null otherwise
  - isThreadSafe
```
public boolean isThreadSafe()
```
    Returns whether this request is thread safe. If it is not, request will be handled consequentially and not in parallel.
    
    Returns:
    
    whether the request is thread safe
  - getDataFragment
```
public int getDataFragment()
```
    Returns a data fragment index. plan to deprecate it in favor of using getFragmentMetadata().
    
    Returns:
    
    data fragment index

Class InputData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INVALID_SPLIT_IDX

requestParametersMap

tupleDescription

segmentId

totalSegments

fragmentMetadata

userData

filterStringValid

filterString

dataSource

accessor

resolver

fragmenter

metadata

remoteLogin

remoteSecret

dataFragment

threadSafe

recordkeyColumn

Constructor Detail

InputData

InputData

Method Detail

getUserProperty

setFragmentMetadata

getFragmentMetadata

getFragmentUserData

setFragmentUserData

getTotalSegments

getSegmentId

hasFilter

getFilterString

getTupleDescription

getColumns

getColumn

getRecordkeyColumn

getDataSource

setDataSource

getAccessor

getResolver

getFragmenter

getMetadata

getLogin

getSecret

isThreadSafe

getDataFragment