org.apache.hcatalog.mapreduce
Class InputJobInfo

Object
  extended by InputJobInfo
All Implemented Interfaces:
Serializable

@InterfaceAudience.Private
@InterfaceStability.Evolving
public class InputJobInfo
extends Object
implements Serializable

Container for metadata read from the metadata server. Prior to release 0.5, InputJobInfo was a key part of the public API, exposed directly to end-users as an argument to HCatInputFormat.setInput(org.apache.hadoop.mapreduce.Job, InputJobInfo). Going forward, we plan on treating InputJobInfo as an implementation detail and no longer expose to end-users. Should you have a need to use InputJobInfo outside HCatalog itself, please contact the developer mailing list before depending on this class.

See Also:
Serialized Form

Method Summary
static InputJobInfo create(String databaseName, String tableName, String filter)
          Deprecated. 
static InputJobInfo create(String databaseName, String tableName, String filter, Properties properties)
          Initializes a new InputJobInfo for reading data from a table.
 String getDatabaseName()
          Gets the value of databaseName
 String getFilter()
          Gets the value of partition filter
 List<PartInfo> getPartitions()
           
 Properties getProperties()
          Set/Get Property information to be passed down to *StorageHandler implementation put implementation specific storage handler configurations here
 HCatTableInfo getTableInfo()
          Gets the table's meta information
 String getTableName()
          Gets the value of tableName
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

create

public static InputJobInfo create(String databaseName,
                                  String tableName,
                                  String filter,
                                  Properties properties)
Initializes a new InputJobInfo for reading data from a table.

Parameters:
databaseName - the db name
tableName - the table name
filter - the partition filter
properties - implementation specific job properties

create

@Deprecated
public static InputJobInfo create(String databaseName,
                                             String tableName,
                                             String filter)
Deprecated. 

Initializes a new InputJobInfo for reading data from a table.

Parameters:
databaseName - the db name
tableName - the table name
filter - the partition filter

getDatabaseName

public String getDatabaseName()
Gets the value of databaseName

Returns:
the databaseName

getTableName

public String getTableName()
Gets the value of tableName

Returns:
the tableName

getTableInfo

public HCatTableInfo getTableInfo()
Gets the table's meta information

Returns:
the HCatTableInfo

getFilter

public String getFilter()
Gets the value of partition filter

Returns:
the filter string

getPartitions

public List<PartInfo> getPartitions()
Returns:
partition info

getProperties

public Properties getProperties()
Set/Get Property information to be passed down to *StorageHandler implementation put implementation specific storage handler configurations here

Returns:
the implementation specific job properties