Package io.deephaven.enterprise.schema

Class SchemaService.Delegating

java.lang.Object

io.deephaven.enterprise.schema.internal.SchemaServiceBase.Delegating

io.deephaven.enterprise.schema.SchemaService.Delegating

All Implemented Interfaces:

SchemaServiceBase, SchemaService, io.deephaven.shadow.enterprise.com.illumon.util.type.NamedImplementation, AutoCloseable

Enclosing interface:

SchemaService

public static class SchemaService.Delegating
extends SchemaServiceBase.Delegating
implements SchemaService

Delegate all method calls to an implementation object. This is designed to be overloaded.

Nested Class Summary

Nested classes/interfaces inherited from interface io.deephaven.enterprise.schema.SchemaService

SchemaService.Delegating

Nested classes/interfaces inherited from interface io.deephaven.enterprise.schema.internal.SchemaServiceBase

SchemaServiceBase.Delegating

Constructor Summary

Constructors

Constructor	Description
Delegating(@NotNull SchemaService delegate)

Method Summary

Modifier and Type	Method	Description
@NotNull Schema	addSchema(@NotNull Schema newSchema)	Add the specified schema to the service.
@NotNull Schema	addSchema(@NotNull Schema newSchema, @NotNull String code, @NotNull String comment)	Add the specified schema to the service.
boolean	createNamespace(@NotNull NamespaceSet namespaceSet, @NotNull String namespaceName)	Add a namespace with the given name to the schema service, in the requested namespace set.
boolean	createNamespace(@NotNull NamespaceSet namespaceSet, @NotNull String namespaceName, @NotNull String code, @NotNull String comment)	Add a namespace with the given name to the schema service, in the requested namespace set.
boolean	createNamespace(@NotNull String namespaceSet, @NotNull String namespaceName)	Convenience method translates the namespace set from string to NamespaceSet and delegate to SchemaService.createNamespace(NamespaceSet, String)
void	deleteSchema(@NotNull Schema schema)	Delete the specified schema.
void	deleteSchema(@NotNull Schema schema, @NotNull String code, @NotNull String comment)	Delete the specified schema.
@NotNull Collection<Schema>	getAllSchemas()	Get a collection of all known schemas in the system.
@NotNull NamespaceSet	getNamespaceSet(@NotNull String namespace)	Get the NamespaceSet for a particular namespace.
@Nullable Schema	getSchema(@NotNull String namespace, @NotNull String tableName)	Get the latest version of the Schema defined by namespace and table name
@NotNull Collection<Schema>	getSchemas(@NotNull NamespaceSet namespaceSet)	Get a collection of all known schemas in the system, with the given namespace set.
@NotNull Collection<Schema>	getSchemas(@NotNull String namespace)	Get a collection of all known schemas in the given namespace.
@NotNull Collection<Schema>	getSchemasForNamespaceSet(@NotNull String namespaceSet)	Convenience method translates the namespace set from string to NamespaceSet and delegate to SchemaService.getSchemas(NamespaceSet)
@NotNull Map<NamespaceSet,Map<String,Collection<String>>>	listAllTables()	Get a map of all known tables in all known namespaces for all namespace sets.
@NotNull Collection<String>	listNamespaces(@NotNull NamespaceSet namespaceSet)	Get a collection of the namespaces available in the given namespace set.
@NotNull Collection<String>	listNamespaces(@NotNull NamespaceSet namespaceSet, boolean includeDeleted)	Get a collection of the namespaces available in the given namespace set.
void	removeNamespace(@NotNull String namespaceName)
void	removeNamespace(@NotNull String namespaceName, @NotNull String code, @NotNull String comment)
@NotNull Schema	updateSchema(@NotNull Schema newSchema)	Update the schema with the same namespace and table name with the specified new schema.
@NotNull Schema	updateSchema(@NotNull Schema newSchema, @NotNull String code, @NotNull String comment)	Update the schema with the same namespace and table name with the specified new schema.

Methods inherited from class io.deephaven.enterprise.schema.internal.SchemaServiceBase.Delegating

about, authenticate, authenticate, authenticate, close, containsNamespace, containsNamespace, containsSchema, deleteSchema, deleteSchema, listNamespaces, listNamespaces, listTableNames, listTableNames, shutdown

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.deephaven.shadow.enterprise.com.illumon.util.type.NamedImplementation

getImplementationName

Methods inherited from interface io.deephaven.enterprise.schema.SchemaService

listNamespaces

Methods inherited from interface io.deephaven.enterprise.schema.internal.SchemaServiceBase

about, authenticate, authenticate, authenticate, close, containsNamespace, containsNamespace, containsSchema, deleteSchema, deleteSchema, initializationStage, listNamespaces, listNamespaces, listTableNames, listTableNames, shutdown

Constructor Details

Delegating

public Delegating(@NotNull
 @NotNull SchemaService delegate)

Method Details

getAllSchemas

@NotNull
public @NotNull Collection<Schema> getAllSchemas()

Description copied from interface: SchemaService

Get a collection of all known schemas in the system. The latest version of each will be returned.

Specified by:

getAllSchemas in interface SchemaService

Returns:

a collection of all known schemas

getSchemas

@NotNull
public @NotNull Collection<Schema> getSchemas(@NotNull
 @NotNull NamespaceSet namespaceSet)

Description copied from interface: SchemaService

Get a collection of all known schemas in the system, with the given namespace set. The latest version of each will be returned.

Specified by:

getSchemas in interface SchemaService

Parameters:

namespaceSet - the namespace set for the schemas

Returns:

a collection of all known schemas in the given namespace set

getSchemasForNamespaceSet

@NotNull
public @NotNull Collection<Schema> getSchemasForNamespaceSet(@NotNull
 @NotNull String namespaceSet)

Description copied from interface: SchemaService

Convenience method translates the namespace set from string to NamespaceSet and delegate to SchemaService.getSchemas(NamespaceSet)

Specified by:

getSchemasForNamespaceSet in interface SchemaService

Parameters:

namespaceSet - the namespace set for the schemas

Returns:

a collection of all known schemas in the given namespace set

getSchema

@Nullable
public @Nullable Schema getSchema(@NotNull
 @NotNull String namespace,
 @NotNull
 @NotNull String tableName)

Description copied from interface: SchemaService

Get the latest version of the Schema defined by namespace and table name

Specified by:

getSchema in interface SchemaService

Parameters:

namespace - the namespace of the table

tableName - the table name

Returns:

the latest version of namespace.tableName or null if none was found

getSchemas

@NotNull
public @NotNull Collection<Schema> getSchemas(@NotNull
 @NotNull String namespace)

Description copied from interface: SchemaService

Get a collection of all known schemas in the given namespace. The latest version of each will be returned.

Specified by:

getSchemas in interface SchemaService

Parameters:

namespace - the namespace of the schemas

Returns:

a collection of all known schemas in the given namespace

getNamespaceSet

@NotNull
public @NotNull NamespaceSet getNamespaceSet(@NotNull
 @NotNull String namespace)
                                      throws IllegalArgumentException

Description copied from interface: SchemaService

Get the NamespaceSet for a particular namespace.

Specified by:

getNamespaceSet in interface SchemaService

Parameters:

namespace - The namespace name

Returns:

the namespace set of the namespace

Throws:

IllegalArgumentException - if the namespace does not exist

listNamespaces

@NotNull
public @NotNull Collection<String> listNamespaces(@NotNull
 @NotNull NamespaceSet namespaceSet)

Description copied from interface: SchemaService

Get a collection of the namespaces available in the given namespace set.

Specified by:

listNamespaces in interface SchemaService

Parameters:

namespaceSet - list namespaces in this namespace set (User, System)

Returns:

a collection of namespace names

listNamespaces

@NotNull
public @NotNull Collection<String> listNamespaces(@NotNull
 @NotNull NamespaceSet namespaceSet,
 boolean includeDeleted)

Description copied from interface: SchemaService

Get a collection of the namespaces available in the given namespace set.

Specified by:

listNamespaces in interface SchemaService

Parameters:

namespaceSet - list namespaces in this set (User, System)

includeDeleted - true if deleted namespaces should be included

Returns:

a collection of namespace names

listAllTables

@NotNull
public @NotNull Map<NamespaceSet,Map<String,Collection<String>>> listAllTables()

Description copied from interface: SchemaService

Get a map of all known tables in all known namespaces for all namespace sets.

Specified by:

listAllTables in interface SchemaService

Returns:

all the table names, mapped by namespace set and namespace

createNamespace

public boolean createNamespace(@NotNull
 @NotNull NamespaceSet namespaceSet,
 @NotNull
 @NotNull String namespaceName)
                        throws SchemaException

Description copied from interface: SchemaService

Add a namespace with the given name to the schema service, in the requested namespace set. Returns true if the namespace was added, false if it already exists. Throws a SchemaException if the namespace could not be added.

Specified by:

createNamespace in interface SchemaService

Parameters:

namespaceSet - add namespaceName to this namespace set

namespaceName - name of the new namespace

Returns:

true if the namespace was added, false if it already exists.

Throws:

SchemaException - if the namespace could not be added to the given namespace set

createNamespace

public boolean createNamespace(@NotNull
 @NotNull String namespaceSet,
 @NotNull
 @NotNull String namespaceName)
                        throws SchemaException

Description copied from interface: SchemaService

Convenience method translates the namespace set from string to NamespaceSet and delegate to SchemaService.createNamespace(NamespaceSet, String)

Specified by:

createNamespace in interface SchemaService

Parameters:

namespaceSet - add namespaceName to this namespace set

namespaceName - name of the new namespace

Returns:

true if the namespace was added, false if it already exists.

Throws:

SchemaException - if the namespace could not be added to the given namespace set

createNamespace

public boolean createNamespace(@NotNull
 @NotNull NamespaceSet namespaceSet,
 @NotNull
 @NotNull String namespaceName,
 @NotNull
 @NotNull String code,
 @NotNull
 @NotNull String comment)
                        throws SchemaException

Description copied from interface: SchemaService

Add a namespace with the given name to the schema service, in the requested namespace set. Returns true if the namespace was added, false if it already exists. Throws a SchemaException if the namespace could not be added.

Specified by:

createNamespace in interface SchemaService

Parameters:

namespaceSet - add namespaceName to this namespace set

namespaceName - name of the new namespace

code - pass-thru to kv persistence, indicates the code source of this update

comment - pass-thru to kv persistence - a comment for this update

Returns:

true if the namespace was added, false if it already exists.

Throws:

SchemaException - if the namespace could not be added to the given namespace set

removeNamespace

public void removeNamespace(@NotNull
 @NotNull String namespaceName)
                     throws SchemaException

Specified by:

removeNamespace in interface SchemaServiceBase

Overrides:

removeNamespace in class SchemaServiceBase.Delegating

Throws:

SchemaException

removeNamespace

public void removeNamespace(@NotNull
 @NotNull String namespaceName,
 @NotNull
 @NotNull String code,
 @NotNull
 @NotNull String comment)
                     throws SchemaException

Specified by:

removeNamespace in interface SchemaServiceBase

Overrides:

removeNamespace in class SchemaServiceBase.Delegating

Throws:

SchemaException

addSchema

@NotNull
public @NotNull Schema addSchema(@NotNull
 @NotNull Schema newSchema)
                          throws SchemaException

Description copied from interface: SchemaService

Add the specified schema to the service.

Specified by:

addSchema in interface SchemaService

Parameters:

newSchema - the schema to add

Returns:

the schema actually stored in the SchemaService

Throws:

SchemaException - if the schema could not be added

addSchema

@NotNull
public @NotNull Schema addSchema(@NotNull
 @NotNull Schema newSchema,
 @NotNull
 @NotNull String code,
 @NotNull
 @NotNull String comment)
                          throws SchemaException

Description copied from interface: SchemaService

Add the specified schema to the service.

Specified by:

addSchema in interface SchemaService

Parameters:

newSchema - the schema to add

code - pass-thru to kv persistence, indicates the code source of this update

comment - pass-thru to kv persistence - a comment for this update

Returns:

the schema actually stored in the SchemaService

Throws:

SchemaException - if the schema could not be added

updateSchema

@NotNull
public @NotNull Schema updateSchema(@NotNull
 @NotNull Schema newSchema)
                             throws IllegalArgumentException,
SchemaException

Description copied from interface: SchemaService

Update the schema with the same namespace and table name with the specified new schema.

Specified by:

updateSchema in interface SchemaService

Parameters:

newSchema - the schema to update with

Returns:

the schema actually stored in the SchemaService

Throws:

IllegalArgumentException - if the namespace or table does not exist

SchemaException - if the schema could not be updated

updateSchema

@NotNull
public @NotNull Schema updateSchema(@NotNull
 @NotNull Schema newSchema,
 @NotNull
 @NotNull String code,
 @NotNull
 @NotNull String comment)
                             throws IllegalArgumentException,
SchemaException

Description copied from interface: SchemaService

Update the schema with the same namespace and table name with the specified new schema.

Specified by:

updateSchema in interface SchemaService

Parameters:

newSchema - the schema to update with

code - pass-thru to kv persistence, indicates the code source of this update

comment - pass-thru to kv persistence - a comment for this update

Returns:

the schema actually stored in the SchemaService

Throws:

IllegalArgumentException - if the namespace or table does not exist

SchemaException - if the schema could not be updated

deleteSchema

public void deleteSchema(@NotNull
 @NotNull Schema schema)
                  throws IllegalArgumentException,
SchemaException

Description copied from interface: SchemaService

Delete the specified schema.

Specified by:

deleteSchema in interface SchemaService

Parameters:

schema - the schema to delete

Throws:

IllegalArgumentException - if the namespace or table could not be found

SchemaException - if the schema could not be deleted

deleteSchema

public void deleteSchema(@NotNull
 @NotNull Schema schema,
 @NotNull
 @NotNull String code,
 @NotNull
 @NotNull String comment)
                  throws IllegalArgumentException,
SchemaException

Description copied from interface: SchemaService

Delete the specified schema.

Specified by:

deleteSchema in interface SchemaService

Parameters:

schema - the schema to delete

code - pass-thru to kv persistence, indicates the code source of this delete

comment - pass-thru to kv persistence - a comment for this delete

Throws:

IllegalArgumentException - if the namespace or table could not be found

SchemaException - if the schema could not be deleted