Package cdc.rdb

Class RdbDatabase

java.lang.Object

cdc.rdb.RdbElement

cdc.rdb.RdbDatabase

public final class RdbDatabase
extends RdbElement

Database description.

It is a root element.
Its content is:

• Properties
• Catalogs
• Data types
• Table types

Author:

Damien Carbonne

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RdbDatabase.BooleanProperty	Enumeration of boolean properties.
static final class	RdbDatabase.Builder
static enum	RdbDatabase.EnumProperty	Enumeration of enum properties.
static enum	RdbDatabase.IntegerProperty	Enumeration of integer properties.
static enum	RdbDatabase.LongProperty	Enumeration of long properties.
static enum	RdbDatabase.PropertyKind
static enum	RdbDatabase.StringProperty	Enumeration of string properties.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KIND

Fields inherited from class cdc.rdb.RdbElement

children, KIND_ATTRIBUTE, KIND_CATALOG, KIND_DATA_TYPE, KIND_DATABASE, KIND_FOREIGN_KEY, KIND_FOREIGN_KEY_COLUMN, KIND_FUNCTION, KIND_FUNCTION_COLUMN, KIND_INDEX, KIND_INDEX_COLUMN, KIND_PRIMARY_KEY, KIND_PRIMARY_KEY_COLUMN, KIND_PROCEDURE, KIND_PROCEDURE_COLUMN, KIND_SCHEMA, KIND_TABLE, KIND_TABLE_COLUMN, KIND_TABLE_TYPE, KIND_USER_DATA_TYPE, name

Constructor Summary

Constructors

Constructor	Description
RdbDatabase(RdbDatabase.Builder builder)

Method Summary

Modifier and Type	Method	Description
static RdbDatabase.Builder	builder()
RdbCatalog.Builder	catalog()
RdbDataType.Builder	dataType()
RdbCatalog	getCatalog(String name)
Iterable<RdbCatalog>	getCatalogs()
RdbElement	getElement(RdbElementPath path)
RdbSchema	getFirstSchemaNamed(String name)
RdbIdentifierNormalizer	getIdentifierNormalizer()
RdbCatalog	getOptionalCatalog(String name)
RdbTableType	getOptionalTableType(String name)
RdbCatalog	getOrCreateCatalog(String name)
RdbElement	getParent()
RdbElementPath	getPath()
boolean	getProperty(RdbDatabase.BooleanProperty property)	Returns the value of a boolean property.
Enum<?>	getProperty(RdbDatabase.EnumProperty property)	Returns the value of an enum property.
int	getProperty(RdbDatabase.IntegerProperty property)	Returns the value of an integer property.
long	getProperty(RdbDatabase.LongProperty property)	Returns the value of a long property.
String	getProperty(RdbDatabase.StringProperty property)	Returns the value of a string property.
static RdbDatabase.PropertyKind	getPropertyKind(String name)
RdbTableType	getTableType(String name)
boolean	isDefined(RdbDatabase.BooleanProperty property)	Returns true if a boolean property is defined.
boolean	isDefined(RdbDatabase.EnumProperty property)	Returns true if an enum property is defined.
boolean	isDefined(RdbDatabase.IntegerProperty property)	Returns true if an integer property is defined.
boolean	isDefined(RdbDatabase.LongProperty property)	Returns true if a long property is defined.
boolean	isDefined(RdbDatabase.StringProperty property)	Returns true if a string property is defined.
void	setProperty(RdbDatabase.BooleanProperty property, boolean value)	Sets a boolean property.
void	setProperty(RdbDatabase.EnumProperty property, Enum<?> value)	Sets an enum property.
void	setProperty(RdbDatabase.IntegerProperty property, int value)	Sets an integer property.
void	setProperty(RdbDatabase.LongProperty property, long value)	Sets a long property.
void	setProperty(RdbDatabase.StringProperty property, String value)	Sets a string property.
RdbTableType.Builder	tableType()

Methods inherited from class cdc.rdb.RdbElement

getChildren, getChildren, getChildren, getChildrenCount, getChildrenCount, getComments, getDepth, getDepth, getElementClass, getElementClasses, getFirstChild, getFirstChild, getKind, getKind, getName, getParentClass, hasChildren, hasChildren, notNull, toString

Methods inherited from class java.lang.Object

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

Field Details

KIND

public static final String KIND

See Also:

• Constant Field Values

Constructor Details

RdbDatabase

public RdbDatabase(RdbDatabase.Builder builder)

Method Details

getParent

public RdbElement getParent()

Specified by:

getParent in class RdbElement

getPath

public RdbElementPath getPath()

Specified by:

getPath in class RdbElement

getIdentifierNormalizer

public RdbIdentifierNormalizer getIdentifierNormalizer()

getPropertyKind

public static RdbDatabase.PropertyKind getPropertyKind(String name)

setProperty

public void setProperty(RdbDatabase.EnumProperty property,
 Enum<?> value)

Sets an enum property.

Parameters:

property - The property.

value - The property value.

isDefined

public boolean isDefined(RdbDatabase.EnumProperty property)

Returns true if an enum property is defined.

Parameters:

property - The property.

Returns:

True if property is defined.

getProperty

public Enum<?> getProperty(RdbDatabase.EnumProperty property)

Returns the value of an enum property.

Parameters:

property - The property.

Returns:

The value of property.

Throws:

IllegalArgumentException - When property is not defined.

setProperty

public void setProperty(RdbDatabase.StringProperty property,
 String value)

Sets a string property.

Parameters:

property - The property.

value - The property value.

isDefined

public boolean isDefined(RdbDatabase.StringProperty property)

Returns true if a string property is defined.

Parameters:

property - The property.

Returns:

True if property is defined.

getProperty

public String getProperty(RdbDatabase.StringProperty property)

Returns the value of a string property.

Parameters:

property - The property.

Returns:

The value of property.

Throws:

IllegalArgumentException - When property is not defined.

setProperty

public void setProperty(RdbDatabase.IntegerProperty property,
 int value)

Sets an integer property.

Parameters:

property - The property.

value - The property value.

isDefined

public boolean isDefined(RdbDatabase.IntegerProperty property)

Returns true if an integer property is defined.

Parameters:

property - The property.

Returns:

True if property is defined.

getProperty

public int getProperty(RdbDatabase.IntegerProperty property)

Returns the value of an integer property.

Parameters:

property - The property.

Returns:

The value of property.

Throws:

IllegalArgumentException - When property is not defined.

setProperty

public void setProperty(RdbDatabase.LongProperty property,
 long value)

Sets a long property.

Parameters:

property - The property.

value - The property value.

isDefined

public boolean isDefined(RdbDatabase.LongProperty property)

Returns true if a long property is defined.

Parameters:

property - The property.

Returns:

True if property is defined.

getProperty

public long getProperty(RdbDatabase.LongProperty property)

Returns the value of a long property.

Parameters:

property - The property.

Returns:

The value of property.

Throws:

IllegalArgumentException - When property is not defined.

setProperty

public void setProperty(RdbDatabase.BooleanProperty property,
 boolean value)

Sets a boolean property.

Parameters:

property - The property.

value - The property value.

isDefined

public boolean isDefined(RdbDatabase.BooleanProperty property)

Returns true if a boolean property is defined.

Parameters:

property - The property.

Returns:

True if property is defined.

getProperty

public boolean getProperty(RdbDatabase.BooleanProperty property)

Returns the value of a boolean property.

Parameters:

property - The property.

Returns:

The value of property.

Throws:

IllegalArgumentException - When property is not defined.

dataType

public RdbDataType.Builder dataType()

tableType

public RdbTableType.Builder tableType()

getOptionalTableType

public RdbTableType getOptionalTableType(String name)

getTableType

public RdbTableType getTableType(String name)

catalog

public RdbCatalog.Builder catalog()

getOptionalCatalog

public RdbCatalog getOptionalCatalog(String name)

getCatalog

public RdbCatalog getCatalog(String name)

getOrCreateCatalog

public RdbCatalog getOrCreateCatalog(String name)

getCatalogs

public Iterable<RdbCatalog> getCatalogs()

getFirstSchemaNamed

public RdbSchema getFirstSchemaNamed(String name)

getElement

public RdbElement getElement(RdbElementPath path)

builder

public static RdbDatabase.Builder builder()