com.speedment.runtime.config.util

Class DocumentDbUtil

java.lang.Object

com.speedment.runtime.config.util.DocumentDbUtil

public final class DocumentDbUtil
extends Object

Common utility methods specific to the database document model.

Since:

2.3.0

Author:

Per Minborg, Emil Forslund

Method Summary

Modifier and Type	Method and Description
static boolean	isAllAncestorsEnabled(Document document) Returns true if the specified document and all its ancestors are enabled.
static boolean	isSame(Column first, Column second) Returns true if the two specified documents represents the same element in the database.
static boolean	isSame(Dbms first, Dbms second) Returns true if the two specified documents represents the same element in the database.
static boolean	isSame(ForeignKeyColumn first, ForeignKeyColumn second) Returns true if the two specified documents represents the same element in the database.
static boolean	isSame(ForeignKey first, ForeignKey second) Returns true if the two specified documents represents the same element in the database.
static boolean	isSame(IndexColumn first, IndexColumn second) Returns true if the two specified documents represents the same element in the database.
static boolean	isSame(Index first, Index second) Returns true if the two specified documents represents the same element in the database.
static boolean	isSame(PrimaryKeyColumn first, PrimaryKeyColumn second) Returns true if the two specified documents represents the same element in the database.
static boolean	isSame(Project first, Project second) Returns true if the two specified documents represents the same element in the database.
static boolean	isSame(Schema first, Schema second) Returns true if the two specified documents represents the same element in the database.
static boolean	isSame(Table first, Table second) Returns true if the two specified documents represents the same element in the database.
static boolean	isUnique(Column column) Returns true if the specified Column represents a column that can only hold unique values in the database.
static Column	referencedColumn(Project project, String dbmsName, String schemaName, String tableName, String columnName)
static <T extends HasDbmsName & HasSchemaName & HasTableName & HasColumnName> Column	referencedColumn(Project project, T identifier)
static Optional<? extends Column>	referencedColumnIfPresent(Project project, ColumnIdentifier<?> identifier)
static Optional<? extends Column>	referencedColumnIfPresent(Project project, String dbmsId, String schemaId, String tableId, String columnId)
static Dbms	referencedDbms(Project project, HasDbmsName identifier)
static Dbms	referencedDbms(Project project, String dbmsId)
static Optional<? extends Dbms>	referencedDbmsIfPresent(Project project, ColumnIdentifier<?> identifier)
static Optional<? extends Dbms>	referencedDbmsIfPresent(Project project, String dbmsId)
static Schema	referencedSchema(Project project, String dbmsId, String schemaId)
static <T extends HasDbmsName & HasSchemaName> Schema	referencedSchema(Project project, T identifier)
static Optional<? extends Schema>	referencedSchemaIfPresent(Project project, ColumnIdentifier<?> identifier)
static Optional<? extends Schema>	referencedSchemaIfPresent(Project project, String dbmsId, String schemaId)
static Table	referencedTable(Project project, String dbmsId, String schemaId, String tableId)
static <T extends HasDbmsName & HasSchemaName & HasTableName> Table	referencedTable(Project project, T identifier)
static Optional<? extends Table>	referencedTableIfPresent(Project project, ColumnIdentifier<?> identifier)
static Optional<? extends Table>	referencedTableIfPresent(Project project, String dbmsId, String schemaId, String tableId)
static Stream<? extends Document>	traverseOver(Column column)
static <T> Stream<T>	traverseOver(Column column, Class<T> clazz)
static Stream<? extends Document>	traverseOver(Dbms dbms)
static <T> Stream<T>	traverseOver(Dbms dbms, Class<T> clazz)
static Stream<? extends Document>	traverseOver(ForeignKey foreignKey)
static <T> Stream<T>	traverseOver(ForeignKey fk, Class<T> clazz)
static Stream<? extends Document>	traverseOver(ForeignKeyColumn foreignKeyColumn)
static <T> Stream<T>	traverseOver(ForeignKeyColumn foreignKeyColumn, Class<T> clazz)
static Stream<? extends Document>	traverseOver(Index index)
static <T> Stream<T>	traverseOver(Index index, Class<T> clazz)
static Stream<? extends Document>	traverseOver(IndexColumn indexColumn)
static <T> Stream<T>	traverseOver(IndexColumn indexColumn, Class<T> clazz)
static Stream<? extends Document>	traverseOver(PrimaryKeyColumn primaryKeyColumn)
static <T> Stream<T>	traverseOver(PrimaryKeyColumn pkColumn, Class<T> clazz)
static Stream<? extends Document>	traverseOver(Project project)
static <T> Stream<T>	traverseOver(Project project, Class<T> clazz)
static Stream<? extends Document>	traverseOver(Schema schema)
static <T> Stream<T>	traverseOver(Schema schema, Class<T> clazz)
static Stream<? extends Document>	traverseOver(Table table)
static <T> Stream<T>	traverseOver(Table table, Class<T> clazz)
static Stream<? extends Document>	typedChildrenOf(Table table)

Methods inherited from class java.lang.Object

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

Method Detail

traverseOver

public static Stream<? extends Document> traverseOver(Project project)

traverseOver

public static Stream<? extends Document> traverseOver(Dbms dbms)

traverseOver

public static Stream<? extends Document> traverseOver(Schema schema)

traverseOver

public static Stream<? extends Document> traverseOver(Table table)

traverseOver

public static Stream<? extends Document> traverseOver(Column column)

traverseOver

public static Stream<? extends Document> traverseOver(PrimaryKeyColumn primaryKeyColumn)

traverseOver

public static Stream<? extends Document> traverseOver(Index index)

traverseOver

public static Stream<? extends Document> traverseOver(IndexColumn indexColumn)

traverseOver

public static Stream<? extends Document> traverseOver(ForeignKey foreignKey)

traverseOver

public static Stream<? extends Document> traverseOver(ForeignKeyColumn foreignKeyColumn)

traverseOver

public static <T> Stream<T> traverseOver(Project project,
                                         Class<T> clazz)

traverseOver

public static <T> Stream<T> traverseOver(Dbms dbms,
                                         Class<T> clazz)

traverseOver

public static <T> Stream<T> traverseOver(Schema schema,
                                         Class<T> clazz)

traverseOver

public static <T> Stream<T> traverseOver(Table table,
                                         Class<T> clazz)

traverseOver

public static <T> Stream<T> traverseOver(Column column,
                                         Class<T> clazz)

traverseOver

public static <T> Stream<T> traverseOver(PrimaryKeyColumn pkColumn,
                                         Class<T> clazz)

traverseOver

public static <T> Stream<T> traverseOver(Index index,
                                         Class<T> clazz)

traverseOver

public static <T> Stream<T> traverseOver(IndexColumn indexColumn,
                                         Class<T> clazz)

traverseOver

public static <T> Stream<T> traverseOver(ForeignKey fk,
                                         Class<T> clazz)

traverseOver

public static <T> Stream<T> traverseOver(ForeignKeyColumn foreignKeyColumn,
                                         Class<T> clazz)

typedChildrenOf

public static Stream<? extends Document> typedChildrenOf(Table table)

isUnique

public static boolean isUnique(Column column)
                        throws SpeedmentConfigException

Returns true if the specified Column represents a column that can only hold unique values in the database.

Parameters:

column - the column

Returns:

true if unique, else false

Throws:

SpeedmentConfigException - if an index or PK could not be traversed

isAllAncestorsEnabled

public static boolean isAllAncestorsEnabled(Document document)

Returns true if the specified document and all its ancestors are enabled. If at least one ancestor is not enabled, false is returned.

Parameters:

document - the document to test

Returns:

true if enabled, else false

referencedColumnIfPresent

public static Optional<? extends Column> referencedColumnIfPresent(Project project,
                                                                   ColumnIdentifier<?> identifier)

referencedTableIfPresent

public static Optional<? extends Table> referencedTableIfPresent(Project project,
                                                                 ColumnIdentifier<?> identifier)

referencedSchemaIfPresent

public static Optional<? extends Schema> referencedSchemaIfPresent(Project project,
                                                                   ColumnIdentifier<?> identifier)

referencedDbmsIfPresent

public static Optional<? extends Dbms> referencedDbmsIfPresent(Project project,
                                                               ColumnIdentifier<?> identifier)

referencedColumnIfPresent

public static Optional<? extends Column> referencedColumnIfPresent(Project project,
                                                                   String dbmsId,
                                                                   String schemaId,
                                                                   String tableId,
                                                                   String columnId)

referencedTableIfPresent

public static Optional<? extends Table> referencedTableIfPresent(Project project,
                                                                 String dbmsId,
                                                                 String schemaId,
                                                                 String tableId)

referencedSchemaIfPresent

public static Optional<? extends Schema> referencedSchemaIfPresent(Project project,
                                                                   String dbmsId,
                                                                   String schemaId)

referencedDbmsIfPresent

public static Optional<? extends Dbms> referencedDbmsIfPresent(Project project,
                                                               String dbmsId)

referencedColumn

public static <T extends HasDbmsName & HasSchemaName & HasTableName & HasColumnName> Column referencedColumn(Project project,
                                                                                                             T identifier)

referencedTable

public static <T extends HasDbmsName & HasSchemaName & HasTableName> Table referencedTable(Project project,
                                                                                           T identifier)

referencedSchema

public static <T extends HasDbmsName & HasSchemaName> Schema referencedSchema(Project project,
                                                                              T identifier)

referencedDbms

public static Dbms referencedDbms(Project project,
                                  HasDbmsName identifier)

referencedColumn

public static Column referencedColumn(Project project,
                                      String dbmsName,
                                      String schemaName,
                                      String tableName,
                                      String columnName)

referencedTable

public static Table referencedTable(Project project,
                                    String dbmsId,
                                    String schemaId,
                                    String tableId)

referencedSchema

public static Schema referencedSchema(Project project,
                                      String dbmsId,
                                      String schemaId)

referencedDbms

public static Dbms referencedDbms(Project project,
                                  String dbmsId)

isSame

public static boolean isSame(Column first,
                             Column second)

Returns true if the two specified documents represents the same element in the database. Two documents are considered same if they have the same name and type and their parents are considered same.

Parameters:

first - the first document

second - the second document

Returns:

true if same, else false

isSame

public static boolean isSame(IndexColumn first,
                             IndexColumn second)

Returns true if the two specified documents represents the same element in the database. Two documents are considered same if they have the same name and type and their parents are considered same.

Parameters:

first - the first document

second - the second document

Returns:

true if same, else false

isSame

public static boolean isSame(Index first,
                             Index second)

Returns true if the two specified documents represents the same element in the database. Two documents are considered same if they have the same name and type and their parents are considered same.

Parameters:

first - the first document

second - the second document

Returns:

true if same, else false

isSame

public static boolean isSame(PrimaryKeyColumn first,
                             PrimaryKeyColumn second)

Returns true if the two specified documents represents the same element in the database. Two documents are considered same if they have the same name and type and their parents are considered same.

Parameters:

first - the first document

second - the second document

Returns:

true if same, else false

isSame

public static boolean isSame(ForeignKeyColumn first,
                             ForeignKeyColumn second)

Returns true if the two specified documents represents the same element in the database. Two documents are considered same if they have the same name and type and their parents are considered same.

Parameters:

first - the first document

second - the second document

Returns:

true if same, else false

isSame

public static boolean isSame(ForeignKey first,
                             ForeignKey second)

Returns true if the two specified documents represents the same element in the database. Two documents are considered same if they have the same name and type and their parents are considered same.

Parameters:

first - the first document

second - the second document

Returns:

true if same, else false

isSame

public static boolean isSame(Table first,
                             Table second)

Returns true if the two specified documents represents the same element in the database. Two documents are considered same if they have the same name and type and their parents are considered same.

Parameters:

first - the first document

second - the second document

Returns:

true if same, else false

isSame

public static boolean isSame(Schema first,
                             Schema second)

Returns true if the two specified documents represents the same element in the database. Two documents are considered same if they have the same name and type and their parents are considered same.

Parameters:

first - the first document

second - the second document

Returns:

true if same, else false

isSame

public static boolean isSame(Dbms first,
                             Dbms second)

Returns true if the two specified documents represents the same element in the database. Two documents are considered same if they have the same name and type and their parents are considered same.

Parameters:

first - the first document

second - the second document

Returns:

true if same, else false

isSame

public static boolean isSame(Project first,
                             Project second)

Returns true if the two specified documents represents the same element in the database. Two documents are considered same if they have the same name and type and their parents are considered same.

Parameters:

first - the first document

second - the second document

Returns:

true if same, else false