com.datastrato.gravitino

Class Namespace

java.lang.Object

com.datastrato.gravitino.Namespace

public class Namespace
extends java.lang.Object

A namespace is a sequence of levels separated by dots. It's used to identify a metalake, a catalog or a schema. For example, "metalake1", "metalake1.catalog1" and "metalake1.catalog1.schema1" are all valid namespaces.

Method Summary

Modifier and Type	Method and Description
static void	check(boolean expression, java.lang.String message, java.lang.Object... args) Check the given condition is true.
static void	checkCatalog(Namespace namespace) Check if the given catalog namespace is legal, throw an IllegalNamespaceException if it's illegal.
static void	checkFileset(Namespace namespace) Check if the given fileset namespace is legal, throw an IllegalNamespaceException if it's illegal.
static void	checkMetalake(Namespace namespace) Check if the given metalake namespace is legal, throw an IllegalNamespaceException if it's illegal.
static void	checkSchema(Namespace namespace) Check if the given schema namespace is legal, throw an IllegalNamespaceException if it's illegal.
static void	checkTable(Namespace namespace) Check if the given table namespace is legal, throw an IllegalNamespaceException if it's illegal.
static void	checkTopic(Namespace namespace) Check if the given topic namespace is legal, throw an IllegalNamespaceException if it's illegal.
static Namespace	empty() Get an empty namespace.
boolean	equals(java.lang.Object other)
int	hashCode()
boolean	isEmpty() Check if the namespace is empty.
int	length() Get the length of the namespace.
java.lang.String	level(int pos) Get the level at the given position.
java.lang.String[]	levels() Get the levels of the namespace.
static Namespace	of(java.lang.String... levels) Create a namespace with the given levels.
static Namespace	ofCatalog(java.lang.String metalake) Create a namespace for catalog.
static Namespace	ofFileset(java.lang.String metalake, java.lang.String catalog, java.lang.String schema) Create a namespace for fileset.
static Namespace	ofMetalake() Create a namespace for metalake.
static Namespace	ofSchema(java.lang.String metalake, java.lang.String catalog) Create a namespace for schema.
static Namespace	ofTable(java.lang.String metalake, java.lang.String catalog, java.lang.String schema) Create a namespace for table.
static Namespace	ofTopic(java.lang.String metalake, java.lang.String catalog, java.lang.String schema) Create a namespace for topic.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

empty

public static Namespace empty()

Get an empty namespace.

Returns:

An empty namespace

of

public static Namespace of(java.lang.String... levels)

Create a namespace with the given levels.

Parameters:

levels - The levels of the namespace

Returns:

A namespace with the given levels

ofMetalake

public static Namespace ofMetalake()

Create a namespace for metalake.

Returns:

A namespace for metalake

ofCatalog

public static Namespace ofCatalog(java.lang.String metalake)

Create a namespace for catalog.

Parameters:

metalake - The metalake name

Returns:

A namespace for catalog

ofSchema

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

Create a namespace for schema.

Parameters:

metalake - The metalake name

catalog - The catalog name

Returns:

A namespace for schema

ofTable

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

Create a namespace for table.

Parameters:

metalake - The metalake name

catalog - The catalog name

schema - The schema name

Returns:

A namespace for table

ofFileset

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

Create a namespace for fileset.

Parameters:

metalake - The metalake name

catalog - The catalog name

schema - The schema name

Returns:

A namespace for fileset

ofTopic

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

Create a namespace for topic.

Parameters:

metalake - The metalake name

catalog - The catalog name

schema - The schema name

Returns:

A namespace for topic

checkMetalake

public static void checkMetalake(Namespace namespace)

Check if the given metalake namespace is legal, throw an IllegalNamespaceException if it's illegal.

Parameters:

namespace - The metalake namespace

checkCatalog

public static void checkCatalog(Namespace namespace)

Check if the given catalog namespace is legal, throw an IllegalNamespaceException if it's illegal.

Parameters:

namespace - The catalog namespace

checkSchema

public static void checkSchema(Namespace namespace)

Check if the given schema namespace is legal, throw an IllegalNamespaceException if it's illegal.

Parameters:

namespace - The schema namespace

checkTable

public static void checkTable(Namespace namespace)

Check if the given table namespace is legal, throw an IllegalNamespaceException if it's illegal.

Parameters:

namespace - The table namespace

checkFileset

public static void checkFileset(Namespace namespace)

Check if the given fileset namespace is legal, throw an IllegalNamespaceException if it's illegal.

Parameters:

namespace - The fileset namespace

checkTopic

public static void checkTopic(Namespace namespace)

Check if the given topic namespace is legal, throw an IllegalNamespaceException if it's illegal.

Parameters:

namespace - The topic namespace

levels

public java.lang.String[] levels()

Get the levels of the namespace.

Returns:

The levels of the namespace

level

public java.lang.String level(int pos)

Get the level at the given position.

Parameters:

pos - The position of the level

Returns:

The level at the given position

length

public int length()

Get the length of the namespace.

Returns:

The length of the namespace.

isEmpty

public boolean isEmpty()

Check if the namespace is empty.

Returns:

True if the namespace is empty, false otherwise.

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 expression,
                                       @FormatString
                                       java.lang.String message,
                                       java.lang.Object... args)

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

Parameters:

expression - The expression to check.

message - The message to throw.

args - The arguments to the message.