org.apache.hive.hcatalog.data.schema

Class HCatFieldSchema

java.lang.Object

org.apache.hive.hcatalog.data.schema.HCatFieldSchema

All Implemented Interfaces:

Serializable

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class HCatFieldSchema
extends Object
implements Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HCatFieldSchema.Category
static class	HCatFieldSchema.Type

Constructor Summary

Constructors

Constructor and Description
HCatFieldSchema(String fieldName, HCatFieldSchema.Type type, HCatFieldSchema.Type mapKeyType, HCatSchema mapValueSchema, String comment) Deprecated. as of 0.13, slated for removal with 0.15 use createMapTypeFieldSchema(String, org.apache.hadoop.hive.serde2.typeinfo.PrimitiveTypeInfo, HCatSchema, String)
HCatFieldSchema(String fieldName, HCatFieldSchema.Type type, HCatSchema subSchema, String comment) Constructor for constructing a ARRAY type or STRUCT type HCatFieldSchema, passing type and subschema
HCatFieldSchema(String fieldName, HCatFieldSchema.Type type, String comment) Deprecated. as of 0.13, slated for removal with 0.15 use HCatFieldSchema(String, org.apache.hadoop.hive.serde2.typeinfo.PrimitiveTypeInfo, String)
HCatFieldSchema(String fieldName, PrimitiveTypeInfo typeInfo, String comment)

Method Summary

Modifier and Type	Method and Description
static HCatFieldSchema	createMapTypeFieldSchema(String fieldName, PrimitiveTypeInfo mapKeyType, HCatSchema mapValueSchema, String comment)
boolean	equals(Object obj)
HCatSchema	getArrayElementSchema()
HCatFieldSchema.Category	getCategory() Returns category of the field
String	getComment()
HCatFieldSchema.Type	getMapKeyType() Deprecated. as of 0.13, slated for removal with 0.15 use getMapKeyTypeInfo() instead
PrimitiveTypeInfo	getMapKeyTypeInfo()
HCatSchema	getMapValueSchema()
String	getName() Returns name of the field
HCatSchema	getStructSubSchema()
HCatFieldSchema.Type	getType() Deprecated. as of 0.13, slated for removal with 0.15 use getTypeInfo() instead
PrimitiveTypeInfo	getTypeInfo() May return null
String	getTypeString()
int	hashCode()
boolean	isComplex()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HCatFieldSchema

public HCatFieldSchema(String fieldName,
                       HCatFieldSchema.Type type,
                       String comment)
                throws HCatException

Deprecated. as of 0.13, slated for removal with 0.15 use HCatFieldSchema(String, org.apache.hadoop.hive.serde2.typeinfo.PrimitiveTypeInfo, String)

Constructor constructing a primitive datatype HCatFieldSchema

Parameters:

fieldName - Name of the primitive field

type - Type of the primitive field

Throws:

HCatException - if call made on non-primitive types

HCatFieldSchema

public HCatFieldSchema(String fieldName,
                       PrimitiveTypeInfo typeInfo,
                       String comment)
                throws HCatException

Throws:

HCatException

HCatFieldSchema

public HCatFieldSchema(String fieldName,
                       HCatFieldSchema.Type type,
                       HCatSchema subSchema,
                       String comment)
                throws HCatException

Constructor for constructing a ARRAY type or STRUCT type HCatFieldSchema, passing type and subschema

Parameters:

fieldName - Name of the array or struct field

type - Type of the field - either Type.ARRAY or Type.STRUCT

subSchema - - subschema of the struct, or element schema of the elements in the array

Throws:

HCatException - if call made on Primitive or Map types

HCatFieldSchema

public HCatFieldSchema(String fieldName,
                       HCatFieldSchema.Type type,
                       HCatFieldSchema.Type mapKeyType,
                       HCatSchema mapValueSchema,
                       String comment)
                throws HCatException

Deprecated. as of 0.13, slated for removal with 0.15 use createMapTypeFieldSchema(String, org.apache.hadoop.hive.serde2.typeinfo.PrimitiveTypeInfo, HCatSchema, String)

Constructor for constructing a MAP type HCatFieldSchema, passing type of key and value

Parameters:

fieldName - Name of the array or struct field

type - Type of the field - must be Type.MAP

mapKeyType - - key type of the Map

mapValueSchema - - subschema of the value of the Map

Throws:

HCatException - if call made on non-Map types

Method Detail

isComplex

public boolean isComplex()

getType

public HCatFieldSchema.Type getType()

Deprecated. as of 0.13, slated for removal with 0.15 use getTypeInfo() instead

Returns type of the field

Returns:

type of the field

getCategory

public HCatFieldSchema.Category getCategory()

Returns category of the field

Returns:

category of the field

getName

public String getName()

Returns name of the field

Returns:

name of the field

getComment

public String getComment()

getTypeInfo

public PrimitiveTypeInfo getTypeInfo()

May return null

createMapTypeFieldSchema

public static HCatFieldSchema createMapTypeFieldSchema(String fieldName,
                                                       PrimitiveTypeInfo mapKeyType,
                                                       HCatSchema mapValueSchema,
                                                       String comment)
                                                throws HCatException

Throws:

HCatException

getStructSubSchema

public HCatSchema getStructSubSchema()
                              throws HCatException

Throws:

HCatException

getArrayElementSchema

public HCatSchema getArrayElementSchema()
                                 throws HCatException

Throws:

HCatException

getMapKeyType

public HCatFieldSchema.Type getMapKeyType()
                                   throws HCatException

Deprecated. as of 0.13, slated for removal with 0.15 use getMapKeyTypeInfo() instead

Throws:

HCatException

getMapKeyTypeInfo

public PrimitiveTypeInfo getMapKeyTypeInfo()
                                    throws HCatException

Throws:

HCatException

getMapValueSchema

public HCatSchema getMapValueSchema()
                             throws HCatException

Throws:

HCatException

toString

public String toString()

Overrides:

toString in class Object

getTypeString

public String getTypeString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object