org.apache.hadoop.hive.ql.hooks

Class Entity

java.lang.Object

org.apache.hadoop.hive.ql.hooks.Entity

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ReadEntity, WriteEntity

public class Entity
extends Object
implements Serializable

This class encapsulates an object that is being read or written to by the query. This object may be a table, partition, dfs directory or a local directory.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Entity.Type The type of the entity.

Constructor Summary

Constructors

Constructor and Description
Entity() Only used by serialization.
Entity(org.apache.hadoop.hive.metastore.api.Database database, boolean complete) Constructor for a database.
Entity(org.apache.hadoop.hive.metastore.api.Database database, String strObj, String className, Entity.Type type) Create an entity representing a object with given name, database namespace and type
Entity(org.apache.hadoop.hive.metastore.api.DataConnector dataconnector, boolean complete) Constructor for a dataconnector.
Entity(DummyPartition p, boolean complete)
Entity(org.apache.hadoop.hive.metastore.api.Function f, boolean complete) Constructor for a function.
Entity(Partition p, boolean complete) Constructor for a partition.
Entity(org.apache.hadoop.fs.Path d, boolean islocal, boolean complete)
Entity(String name, Entity.Type t) Constructor for a entity with string object representation (eg SERVICE_NAME)
Entity(Table t, boolean complete) Constructor for a table.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Equals function.
String	getClassName()
org.apache.hadoop.fs.Path	getD()
org.apache.hadoop.hive.metastore.api.Database	getDatabase()
org.apache.hadoop.hive.metastore.api.DataConnector	getDataConnector()
org.apache.hadoop.hive.metastore.api.Function	getFunction() Get the function associated with the entity.
String	getFunctionName()
URI	getLocation() Get the location of the entity.
String	getName()
Partition	getP()
Map<String,String>	getParameters() Get the parameter map of the Entity.
Partition	getPartition() Get the partition associated with the entity.
String	getServiceName()
Table	getT()
Table	getTable() Get the table associated with the entity.
Entity.Type	getTyp()
Entity.Type	getType() Get the type of the entity.
int	hashCode() Hashcode function.
boolean	isComplete()
boolean	isDummy()
boolean	isPathType()
void	setClassName(String className)
void	setComplete(boolean complete)
void	setD(org.apache.hadoop.fs.Path d)
void	setDatabase(org.apache.hadoop.hive.metastore.api.Database database)
void	setDataConnector(org.apache.hadoop.hive.metastore.api.DataConnector connector)
void	setFunctionName(String funcName)
void	setP(Partition p)
void	setT(Table t)
void	setTyp(Entity.Type typ)
String	toString() toString function.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Entity

public Entity()

Only used by serialization.

Entity

public Entity(org.apache.hadoop.hive.metastore.api.Database database,
              boolean complete)

Constructor for a database.

Parameters:

database - Database that is read or written to.

complete - Means the database is target, not for table or partition, etc.

Entity

public Entity(org.apache.hadoop.hive.metastore.api.DataConnector dataconnector,
              boolean complete)

Constructor for a dataconnector.

Parameters:

dataconnector - Database that is read or written to.

complete - Means the dataconnector is target

Entity

public Entity(String name,
              Entity.Type t)

Constructor for a entity with string object representation (eg SERVICE_NAME)

Parameters:

name - Used for service that action is being authorized on. Currently hostname is used for service name.

t - Type of entity

Entity

public Entity(Table t,
              boolean complete)

Constructor for a table.

Parameters:

t - Table that is read or written to.

Entity

public Entity(Partition p,
              boolean complete)

Constructor for a partition.

Parameters:

p - Partition that is read or written to.

Entity

public Entity(DummyPartition p,
              boolean complete)

Entity

public Entity(org.apache.hadoop.fs.Path d,
              boolean islocal,
              boolean complete)

Entity

public Entity(org.apache.hadoop.hive.metastore.api.Database database,
              String strObj,
              String className,
              Entity.Type type)

Create an entity representing a object with given name, database namespace and type

Parameters:

database - - database namespace

strObj - - object name as string

className - - function class name

type - - the entity type. this constructor only supports FUNCTION type currently

Entity

public Entity(org.apache.hadoop.hive.metastore.api.Function f,
              boolean complete)

Constructor for a function.

Parameters:

f - Function that is read or written to.

Method Detail

isComplete

public boolean isComplete()

setComplete

public void setComplete(boolean complete)

getName

public String getName()

getDatabase

public org.apache.hadoop.hive.metastore.api.Database getDatabase()

setDatabase

public void setDatabase(org.apache.hadoop.hive.metastore.api.Database database)

getDataConnector

public org.apache.hadoop.hive.metastore.api.DataConnector getDataConnector()

setDataConnector

public void setDataConnector(org.apache.hadoop.hive.metastore.api.DataConnector connector)

getTyp

public Entity.Type getTyp()

setTyp

public void setTyp(Entity.Type typ)

getT

public Table getT()

setT

public void setT(Table t)

getP

public Partition getP()

setP

public void setP(Partition p)

getD

public org.apache.hadoop.fs.Path getD()

setD

public void setD(org.apache.hadoop.fs.Path d)

getClassName

public String getClassName()

setClassName

public void setClassName(String className)

getFunctionName

public String getFunctionName()

setFunctionName

public void setFunctionName(String funcName)

getServiceName

public String getServiceName()

getParameters

public Map<String,String> getParameters()

Get the parameter map of the Entity.

getType

public Entity.Type getType()

Get the type of the entity.

isPathType

public boolean isPathType()

getLocation

public URI getLocation()
                throws Exception

Get the location of the entity.

Throws:

Exception

getPartition

public Partition getPartition()

Get the partition associated with the entity.

getTable

public Table getTable()

Get the table associated with the entity.

getFunction

public org.apache.hadoop.hive.metastore.api.Function getFunction()

Get the function associated with the entity.

isDummy

public boolean isDummy()

toString

public String toString()

toString function.

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Equals function.

Overrides:

equals in class Object

hashCode

public int hashCode()

Hashcode function.

Overrides:

hashCode in class Object