Package org.apache.gravitino.dto.rel.indexes

Class IndexDTO

java.lang.Object

org.apache.gravitino.dto.rel.indexes.IndexDTO

All Implemented Interfaces:

Index

public class IndexDTO
extends Object
implements Index

Data transfer object representing index information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndexDTO.Builder<S extends IndexDTO.Builder>	Builder for creating a new instance of IndexDTO.

Nested classes/interfaces inherited from interface org.apache.gravitino.rel.indexes.Index

Index.IndexType

Field Summary

Fields

Modifier and Type	Field	Description
static final IndexDTO[]	EMPTY_INDEXES	An empty array of indexes.

Constructor Summary

Constructors

Constructor	Description
IndexDTO()	Default constructor for Jackson deserialization.
IndexDTO(Index.IndexType indexType, String name, String[][] fieldNames)	Creates a new instance of IndexDTO

Method Summary

Modifier and Type	Method	Description
static IndexDTO.Builder	builder()	Get the builder for creating a new instance of IndexDTO.
boolean	equals(Object o)
String[][]	fieldNames()
int	hashCode()
String	name()
Index.IndexType	type()

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_INDEXES

public static final IndexDTO[] EMPTY_INDEXES

An empty array of indexes.

Constructor Details

IndexDTO

public IndexDTO()

Default constructor for Jackson deserialization.

IndexDTO

public IndexDTO(Index.IndexType indexType,
 String name,
 String[][] fieldNames)

Creates a new instance of IndexDTO

Parameters:

indexType - The type of the index.

name - The name of the index.

fieldNames - The names of the fields.

Method Details

type

public Index.IndexType type()

Specified by:

type in interface Index

Returns:

The type of the index.

name

public String name()

Specified by:

name in interface Index

Returns:

The name of the index.

fieldNames

public String[][] fieldNames()

Specified by:

fieldNames in interface Index

Returns:

The field name under the table contained in the index.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static IndexDTO.Builder builder()

Get the builder for creating a new instance of IndexDTO.

Returns:

The builder.