org.apache.hadoop.hive.serde2.objectinspector

Class SubStructObjectInspector

java.lang.Object

org.apache.hadoop.hive.serde2.objectinspector.StructObjectInspector

org.apache.hadoop.hive.serde2.objectinspector.SubStructObjectInspector

All Implemented Interfaces:

Cloneable, ObjectInspector

public class SubStructObjectInspector
extends StructObjectInspector

SubsetStructObjectInspector implement a wrapper around a base object inspector (baseOI) such that when the row corresponding to the baseOI is given together with this object inspector, it will mask out some fields in the row as if they are not there.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hive.serde2.objectinspector.ObjectInspector

ObjectInspector.Category

Field Summary

Fields

Modifier and Type	Field and Description
protected StructObjectInspector	baseOI
protected List<StructField>	fields
protected int	numCols
protected int	startCol

Constructor Summary

Constructors

Constructor and Description
SubStructObjectInspector(StructObjectInspector baseOI, int startCol, int numCols) Create a new Object Inspector based on a base object inspector and the subset of columns will be inspected (from startCol to startCol+numCols).

Method Summary

Modifier and Type	Method and Description
List<? extends StructField>	getAllStructFieldRefs() Returns all the fields.
ObjectInspector.Category	getCategory() An ObjectInspector must inherit from one of the following interfaces if getCategory() returns: PRIMITIVE: PrimitiveObjectInspector LIST: ListObjectInspector MAP: MapObjectInspector STRUCT: StructObjectInspector.
Object	getStructFieldData(Object data, StructField fieldRef) returns null for data = null.
StructField	getStructFieldRef(String fieldName) Look up a field.
List<Object>	getStructFieldsDataAsList(Object data) returns null for data = null.
String	getTypeName() Returns the name of the data type that is inspected by this ObjectInspector.

Methods inherited from class org.apache.hadoop.hive.serde2.objectinspector.StructObjectInspector

isSettable, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

baseOI

protected StructObjectInspector baseOI

startCol

protected int startCol

numCols

protected int numCols

fields

protected List<StructField> fields

Constructor Detail

SubStructObjectInspector

public SubStructObjectInspector(StructObjectInspector baseOI,
                                int startCol,
                                int numCols)

Create a new Object Inspector based on a base object inspector and the subset of columns will be inspected (from startCol to startCol+numCols).

Parameters:

baseOI -

startCol -

numCols -

Method Detail

getTypeName

public String getTypeName()

Description copied from interface: ObjectInspector

Returns the name of the data type that is inspected by this ObjectInspector. This is used to display the type information to the user. For primitive types, the type name is standardized. For other types, the type name can be something like "list<int>", "map<int,string>", java class names, or user-defined type names similar to typedef.

getCategory

public ObjectInspector.Category getCategory()

Description copied from interface: ObjectInspector

An ObjectInspector must inherit from one of the following interfaces if getCategory() returns: PRIMITIVE: PrimitiveObjectInspector LIST: ListObjectInspector MAP: MapObjectInspector STRUCT: StructObjectInspector.

getAllStructFieldRefs

public List<? extends StructField> getAllStructFieldRefs()

Description copied from class: StructObjectInspector

Returns all the fields.

Specified by:

getAllStructFieldRefs in class StructObjectInspector

getStructFieldRef

public StructField getStructFieldRef(String fieldName)

Description copied from class: StructObjectInspector

Look up a field.

Specified by:

getStructFieldRef in class StructObjectInspector

getStructFieldData

public Object getStructFieldData(Object data,
                                 StructField fieldRef)

Description copied from class: StructObjectInspector

returns null for data = null.

Specified by:

getStructFieldData in class StructObjectInspector

getStructFieldsDataAsList

public List<Object> getStructFieldsDataAsList(Object data)

Description copied from class: StructObjectInspector

returns null for data = null.

Specified by:

getStructFieldsDataAsList in class StructObjectInspector