com.datastrato.gravitino

Class NameIdentifier

java.lang.Object

com.datastrato.gravitino.NameIdentifier

public class NameIdentifier
extends java.lang.Object

A name identifier is a sequence of names separated by dots. It's used to identify a metalake, a catalog, a schema or a table. For example, "metalake1" can represent a metalake, "metalake1.catalog1" can represent a catalog, "metalake1.catalog1.schema1" can represent a schema.

Method Summary

Modifier and Type	Method and Description
static void	check(boolean condition, java.lang.String message, java.lang.Object... args) Check the given condition is true.
static void	checkCatalog(NameIdentifier ident) Check the given NameIdentifier is a catalog identifier.
static void	checkFileset(NameIdentifier ident) Check the given NameIdentifier is a fileset identifier.
static void	checkMetalake(NameIdentifier ident) Check the given NameIdentifier is a metalake identifier.
static void	checkSchema(NameIdentifier ident) Check the given NameIdentifier is a schema identifier.
static void	checkTable(NameIdentifier ident) Check the given NameIdentifier is a table identifier.
static void	checkTopic(NameIdentifier ident) Check the given NameIdentifier is a topic identifier.
boolean	equals(java.lang.Object other)
int	hashCode()
boolean	hasNamespace() Check if the NameIdentifier has a namespace.
java.lang.String	name() Get the name of the NameIdentifier.
Namespace	namespace() Get the namespace of the NameIdentifier.
static NameIdentifier	of(Namespace namespace, java.lang.String name) Create the NameIdentifier with the given Namespace and name.
static NameIdentifier	of(java.lang.String... names) Create the NameIdentifier with the given levels of names.
static NameIdentifier	ofCatalog(java.lang.String metalake, java.lang.String catalog) Create the catalog NameIdentifier with the given metalake and catalog name.
static NameIdentifier	ofFileset(java.lang.String metalake, java.lang.String catalog, java.lang.String schema, java.lang.String fileset) Create the fileset NameIdentifier with the given metalake, catalog, schema and fileset name.
static NameIdentifier	ofMetalake(java.lang.String metalake) Create the metalake NameIdentifier with the given name.
static NameIdentifier	ofSchema(java.lang.String metalake, java.lang.String catalog, java.lang.String schema) Create the schema NameIdentifier with the given metalake, catalog and schema name.
static NameIdentifier	ofTable(java.lang.String metalake, java.lang.String catalog, java.lang.String schema, java.lang.String table) Create the table NameIdentifier with the given metalake, catalog, schema and table name.
static NameIdentifier	ofTopic(java.lang.String metalake, java.lang.String catalog, java.lang.String schema, java.lang.String topic) Create the topic NameIdentifier with the given metalake, catalog, schema and topic name.
static NameIdentifier	parse(java.lang.String identifier) Create a NameIdentifier from the given identifier string.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

of

public static NameIdentifier of(java.lang.String... names)

Create the NameIdentifier with the given levels of names.

Parameters:

names - The names of the identifier

Returns:

The created NameIdentifier

of

public static NameIdentifier of(Namespace namespace,
                                java.lang.String name)

Create the NameIdentifier with the given Namespace and name.

Parameters:

namespace - The namespace of the identifier

name - The name of the identifier

Returns:

The created NameIdentifier

ofMetalake

public static NameIdentifier ofMetalake(java.lang.String metalake)

Create the metalake NameIdentifier with the given name.

Parameters:

metalake - The metalake name

Returns:

The created metalake NameIdentifier

ofCatalog

public static NameIdentifier ofCatalog(java.lang.String metalake,
                                       java.lang.String catalog)

Create the catalog NameIdentifier with the given metalake and catalog name.

Parameters:

metalake - The metalake name

catalog - The catalog name

Returns:

The created catalog NameIdentifier

ofSchema

public static NameIdentifier ofSchema(java.lang.String metalake,
                                      java.lang.String catalog,
                                      java.lang.String schema)

Create the schema NameIdentifier with the given metalake, catalog and schema name.

Parameters:

metalake - The metalake name

catalog - The catalog name

schema - The schema name

Returns:

The created schema NameIdentifier

ofTable

public static NameIdentifier ofTable(java.lang.String metalake,
                                     java.lang.String catalog,
                                     java.lang.String schema,
                                     java.lang.String table)

Create the table NameIdentifier with the given metalake, catalog, schema and table name.

Parameters:

metalake - The metalake name

catalog - The catalog name

schema - The schema name

table - The table name

Returns:

The created table NameIdentifier

ofFileset

public static NameIdentifier ofFileset(java.lang.String metalake,
                                       java.lang.String catalog,
                                       java.lang.String schema,
                                       java.lang.String fileset)

Create the fileset NameIdentifier with the given metalake, catalog, schema and fileset name.

Parameters:

metalake - The metalake name

catalog - The catalog name

schema - The schema name

fileset - The fileset name

Returns:

The created fileset NameIdentifier

ofTopic

public static NameIdentifier ofTopic(java.lang.String metalake,
                                     java.lang.String catalog,
                                     java.lang.String schema,
                                     java.lang.String topic)

Create the topic NameIdentifier with the given metalake, catalog, schema and topic name.

Parameters:

metalake - The metalake name

catalog - The catalog name

schema - The schema name

topic - The topic name

Returns:

The created topic NameIdentifier

checkMetalake

public static void checkMetalake(NameIdentifier ident)

Check the given NameIdentifier is a metalake identifier. Throw an IllegalNameIdentifierException if it's not.

Parameters:

ident - The metalake NameIdentifier to check.

checkCatalog

public static void checkCatalog(NameIdentifier ident)

Check the given NameIdentifier is a catalog identifier. Throw an IllegalNameIdentifierException if it's not.

Parameters:

ident - The catalog NameIdentifier to check.

checkSchema

public static void checkSchema(NameIdentifier ident)

Check the given NameIdentifier is a schema identifier. Throw an IllegalNameIdentifierException if it's not.

Parameters:

ident - The schema NameIdentifier to check.

checkTable

public static void checkTable(NameIdentifier ident)

Check the given NameIdentifier is a table identifier. Throw an IllegalNameIdentifierException if it's not.

Parameters:

ident - The table NameIdentifier to check.

checkFileset

public static void checkFileset(NameIdentifier ident)

Check the given NameIdentifier is a fileset identifier. Throw an IllegalNameIdentifierException if it's not.

Parameters:

ident - The fileset NameIdentifier to check.

checkTopic

public static void checkTopic(NameIdentifier ident)

Check the given NameIdentifier is a topic identifier. Throw an IllegalNameIdentifierException if it's not.

Parameters:

ident - The topic NameIdentifier to check.

parse

public static NameIdentifier parse(java.lang.String identifier)

Create a NameIdentifier from the given identifier string.

Parameters:

identifier - The identifier string

Returns:

The created NameIdentifier

hasNamespace

public boolean hasNamespace()

Check if the NameIdentifier has a namespace.

Returns:

True if the NameIdentifier has a namespace, false otherwise.

namespace

public Namespace namespace()

Get the namespace of the NameIdentifier.

Returns:

The namespace of the NameIdentifier.

name

public java.lang.String name()

Get the name of the NameIdentifier.

Returns:

The name of the NameIdentifier.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

check

@FormatMethod
public static void check(boolean condition,
                                       @FormatString
                                       java.lang.String message,
                                       java.lang.Object... args)

Check the given condition is true. Throw an IllegalNameIdentifierException if it's not.

Parameters:

condition - The condition to check.

message - The message to throw.

args - The arguments to the message.