com.datastrato.gravitino.dto

Class CatalogDTO

java.lang.Object

com.datastrato.gravitino.dto.CatalogDTO

All Implemented Interfaces:

Auditable, Catalog

Direct Known Subclasses:

RelationalCatalog

public class CatalogDTO
extends java.lang.Object
implements Catalog

Data transfer object representing catalog information.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CatalogDTO.Builder<S extends CatalogDTO.Builder> Builder class for constructing a CatalogDTO instance.

Nested classes/interfaces inherited from interface com.datastrato.gravitino.Catalog

Catalog.Type

Field Summary

Fields inherited from interface com.datastrato.gravitino.Catalog

PROPERTY_PACKAGE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CatalogDTO()
protected	CatalogDTO(java.lang.String name, Catalog.Type type, java.lang.String provider, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties, AuditDTO audit)

Method Summary

Modifier and Type	Method and Description
Audit	auditInfo()
java.lang.String	comment() The comment of the catalog.
java.lang.String	name()
java.util.Map<java.lang.String,java.lang.String>	properties() The properties of the catalog.
java.lang.String	provider()
Catalog.Type	type()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.datastrato.gravitino.Catalog

asSchemas, asTableCatalog

Constructor Detail

CatalogDTO

protected CatalogDTO()

CatalogDTO

protected CatalogDTO(java.lang.String name,
                     Catalog.Type type,
                     java.lang.String provider,
                     java.lang.String comment,
                     java.util.Map<java.lang.String,java.lang.String> properties,
                     AuditDTO audit)

Method Detail

name

public java.lang.String name()

Specified by:

name in interface Catalog

Returns:

The name of the catalog.

type

public Catalog.Type type()

Specified by:

type in interface Catalog

Returns:

The type of the catalog.

provider

public java.lang.String provider()

Specified by:

provider in interface Catalog

Returns:

The provider of the catalog.

comment

public java.lang.String comment()

Description copied from interface: Catalog

The comment of the catalog. Note. this method will return null if the comment is not set for this catalog.

Specified by:

comment in interface Catalog

Returns:

The comment of the catalog.

properties

public java.util.Map<java.lang.String,java.lang.String> properties()

Description copied from interface: Catalog

The properties of the catalog. Note, this method will return null if the properties are not set.

Specified by:

properties in interface Catalog

Returns:

The properties of the catalog.

auditInfo

public Audit auditInfo()

Specified by:

auditInfo in interface Auditable

Returns:

The audit information of the entity.