Module io.ebean.api

Package io.ebean.config

Class TableName

java.lang.Object

io.ebean.config.TableName

public final class TableName
extends Object

TableName holds catalog, schema and table name.

Author:

emcgreal

Constructor Summary

Constructors

Constructor	Description
TableName(String qualifiedTableName)	Construct splitting the qualifiedTableName potentially into catalog, schema and name.
TableName(String catalog, String schema, String name)	Construct with the given catalog schema and table name.

Method Summary

Modifier and Type	Method	Description
String	getCatalog()	Gets the catalog.
String	getName()	Gets the name.
String	getQualifiedName()	Returns the qualified name in the form catalog.schema.name.
String	getSchema()	Gets the schema.
boolean	isValid()	Checks if is table name is valid i.e.
static String	parse(String qualifiedTableName)	Parse a qualifiedTableName that might include a catalog and schema and just return the table name.
String	toString()
String	withCatalogAndSchema(String name)	Append a catalog and schema prefix if they exist to the string builder.

Methods inherited from class java.lang.Object

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

Constructor Details

TableName

public TableName(String catalog,
 String schema,
 String name)

Construct with the given catalog schema and table name.

Note the catalog and schema can be null.

TableName

public TableName(String qualifiedTableName)

Construct splitting the qualifiedTableName potentially into catalog, schema and name.

The qualifiedTableName can take the form of catalog.schema.tableName and is split on the '.' period character. The catalog and schema are optional.

Parameters:

qualifiedTableName - the fully qualified table name using '.' between schema and table name etc (with catalog and schema optional).

Method Details

parse

public static String parse(String qualifiedTableName)

Parse a qualifiedTableName that might include a catalog and schema and just return the table name.

toString

public String toString()

Overrides:

toString in class Object

getCatalog

public String getCatalog()

Gets the catalog.

Returns:

the catalog

getSchema

public String getSchema()

Gets the schema.

Returns:

the schema

getName

public String getName()

Gets the name.

Returns:

the name

getQualifiedName

public String getQualifiedName()

Returns the qualified name in the form catalog.schema.name.

Catalog and schema are optional.

Returns:

the qualified name

withCatalogAndSchema

public String withCatalogAndSchema(String name)

Append a catalog and schema prefix if they exist to the string builder.

isValid

public boolean isValid()

Checks if is table name is valid i.e. it has at least a name.