schemacrawler.schemacrawler

Class BaseCatalogDecorator

java.lang.Object

schemacrawler.schemacrawler.BaseCatalogDecorator

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<NamedObject>, AttributedObject, Catalog, DescribedObject, NamedObject, Reducible

public abstract class BaseCatalogDecorator
extends java.lang.Object
implements Catalog, Reducible

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
int	compareTo(NamedObject o)
<T> T	getAttribute(java.lang.String name) Gets an attribute.
<T> T	getAttribute(java.lang.String name, T defaultValue) Gets an attribute.
java.util.Map<java.lang.String,java.lang.Object>	getAttributes() Gets all attributes.
java.util.Collection<ColumnDataType>	getColumnDataTypes() Gets the column data types
java.util.Collection<ColumnDataType>	getColumnDataTypes(Schema schema) Gets the column data types defined in the schema, by name.
CrawlInfo	getCrawlInfo()
DatabaseInfo	getDatabaseInfo()
java.lang.String	getFullName() Getter for fully qualified name of object.
JdbcDriverInfo	getJdbcDriverInfo()
JvmSystemInfo	getJvmSystemInfo()
java.lang.String	getName() Getter for name of object.
OperatingSystemInfo	getOperatingSystemInfo()
java.lang.String	getRemarks() Getter for remarks.
java.util.Collection<Routine>	getRoutines() Gets the routine.
java.util.Collection<Routine>	getRoutines(Schema schema) Gets the routine.
SchemaCrawlerInfo	getSchemaCrawlerInfo()
java.util.Collection<Schema>	getSchemas() Gets the schemas.
java.util.Collection<Sequence>	getSequences() Gets the sequences.
java.util.Collection<Sequence>	getSequences(Schema schema) Gets the sequences.
java.util.Collection<Synonym>	getSynonyms() Gets the synonyms.
java.util.Collection<Synonym>	getSynonyms(Schema schema) Gets the synonyms.
java.util.Collection<ColumnDataType>	getSystemColumnDataTypes() Gets the column data types defined by the RDBMS system.
java.util.Collection<Table>	getTables() Gets the tables.
java.util.Collection<Table>	getTables(Schema schema) Gets the tables.
boolean	hasAttribute(java.lang.String name) Checks is an attribute is available.
boolean	hasRemarks() Whether remarks are available.
java.util.Optional<? extends ColumnDataType>	lookupColumnDataType(Schema schema, java.lang.String name) Gets the column data types defined in the schema, by name.
java.util.Optional<? extends Routine>	lookupRoutine(Schema schema, java.lang.String name) Gets a routine by unqualified name.
java.util.Optional<? extends Schema>	lookupSchema(java.lang.String name) Gets a schema by name.
java.util.Optional<? extends Sequence>	lookupSequence(Schema schema, java.lang.String name) Gets the sequence by unqualified name.
java.util.Optional<? extends Synonym>	lookupSynonym(Schema schema, java.lang.String name) Gets the synonym by unqualified name.
java.util.Optional<? extends ColumnDataType>	lookupSystemColumnDataType(java.lang.String name) Gets the column data types defined by the RDBMS system, by name.
java.util.Optional<? extends Table>	lookupTable(Schema schema, java.lang.String name) Gets a table by unqualified name.
<N extends NamedObject> void	reduce(java.lang.Class<N> clazz, Reducer<N> reducer)
void	removeAttribute(java.lang.String name) Removes an attribute.
void	setAttribute(java.lang.String name, java.lang.Object value) Sets an attribute.
java.util.List<java.lang.String>	toUniqueLookupKey() A value guaranteed to be unique in the database for this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface schemacrawler.schema.AttributedObject

lookupAttribute

Method Detail

getAttribute

public final <T> T getAttribute(java.lang.String name)

Gets an attribute.

Specified by:

getAttribute in interface AttributedObject

Parameters:

name - Attribute name.

Returns:

Attribute value.

compareTo

public int compareTo(NamedObject o)

Specified by:

compareTo in interface java.lang.Comparable<NamedObject>

getAttribute

public <T> T getAttribute(java.lang.String name,
                          T defaultValue)

Description copied from interface: AttributedObject

Gets an attribute.

Specified by:

getAttribute in interface AttributedObject

Parameters:

name - Attribute name.

Returns:

Attribute value.

getAttributes

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

Description copied from interface: AttributedObject

Gets all attributes.

Specified by:

getAttributes in interface AttributedObject

Returns:

Map of attributes

getColumnDataTypes

public java.util.Collection<ColumnDataType> getColumnDataTypes()

Description copied from interface: Catalog

Gets the column data types

Specified by:

getColumnDataTypes in interface Catalog

Returns:

Column data types

getColumnDataTypes

public java.util.Collection<ColumnDataType> getColumnDataTypes(Schema schema)

Description copied from interface: Catalog

Gets the column data types defined in the schema, by name.

Specified by:

getColumnDataTypes in interface Catalog

Returns:

Column data types

getCrawlInfo

public CrawlInfo getCrawlInfo()

Specified by:

getCrawlInfo in interface Catalog

getDatabaseInfo

public DatabaseInfo getDatabaseInfo()

Specified by:

getDatabaseInfo in interface Catalog

getFullName

public java.lang.String getFullName()

Description copied from interface: NamedObject

Getter for fully qualified name of object.

Specified by:

getFullName in interface NamedObject

Returns:

Fully qualified of the object

getJdbcDriverInfo

public JdbcDriverInfo getJdbcDriverInfo()

Specified by:

getJdbcDriverInfo in interface Catalog

getJvmSystemInfo

public JvmSystemInfo getJvmSystemInfo()

Specified by:

getJvmSystemInfo in interface Catalog

getName

public java.lang.String getName()

Description copied from interface: NamedObject

Getter for name of object.

Specified by:

getName in interface NamedObject

Returns:

Name of the object

getOperatingSystemInfo

public OperatingSystemInfo getOperatingSystemInfo()

Specified by:

getOperatingSystemInfo in interface Catalog

getRemarks

public java.lang.String getRemarks()

Description copied from interface: DescribedObject

Getter for remarks.

Specified by:

getRemarks in interface DescribedObject

Returns:

Remarks

getRoutines

public java.util.Collection<Routine> getRoutines()

Description copied from interface: Catalog

Gets the routine.

Specified by:

getRoutines in interface Catalog

Returns:

Routines

getRoutines

public java.util.Collection<Routine> getRoutines(Schema schema)

Description copied from interface: Catalog

Gets the routine.

Specified by:

getRoutines in interface Catalog

Returns:

Routines

getSchemaCrawlerInfo

public SchemaCrawlerInfo getSchemaCrawlerInfo()

Specified by:

getSchemaCrawlerInfo in interface Catalog

getSchemas

public java.util.Collection<Schema> getSchemas()

Description copied from interface: Catalog

Gets the schemas.

Specified by:

getSchemas in interface Catalog

Returns:

Schemas

getSequences

public java.util.Collection<Sequence> getSequences()

Gets the sequences.

Specified by:

getSequences in interface Catalog

Returns:

Sequences

getSequences

public java.util.Collection<Sequence> getSequences(Schema schema)

Gets the sequences.

Specified by:

getSequences in interface Catalog

Returns:

Sequences

getSynonyms

public java.util.Collection<Synonym> getSynonyms()

Description copied from interface: Catalog

Gets the synonyms.

Specified by:

getSynonyms in interface Catalog

Returns:

Synonyms

getSynonyms

public java.util.Collection<Synonym> getSynonyms(Schema schema)

Description copied from interface: Catalog

Gets the synonyms.

Specified by:

getSynonyms in interface Catalog

Returns:

Synonyms

getSystemColumnDataTypes

public java.util.Collection<ColumnDataType> getSystemColumnDataTypes()

Description copied from interface: Catalog

Gets the column data types defined by the RDBMS system.

Specified by:

getSystemColumnDataTypes in interface Catalog

Returns:

Column data types

getTables

public java.util.Collection<Table> getTables()

Description copied from interface: Catalog

Gets the tables.

Specified by:

getTables in interface Catalog

Returns:

Tables

getTables

public java.util.Collection<Table> getTables(Schema schema)

Description copied from interface: Catalog

Gets the tables.

Specified by:

getTables in interface Catalog

Returns:

Tables

hasAttribute

public boolean hasAttribute(java.lang.String name)

Description copied from interface: AttributedObject

Checks is an attribute is available.

Specified by:

hasAttribute in interface AttributedObject

Parameters:

name - Attribute name.

Returns:

If attribute is available.

hasRemarks

public boolean hasRemarks()

Description copied from interface: DescribedObject

Whether remarks are available.

Specified by:

hasRemarks in interface DescribedObject

Returns:

Remarks

lookupColumnDataType

public java.util.Optional<? extends ColumnDataType> lookupColumnDataType(Schema schema,
                                                                         java.lang.String name)

Description copied from interface: Catalog

Gets the column data types defined in the schema, by name.

Specified by:

lookupColumnDataType in interface Catalog

name - Name

Returns:

Column data types

lookupRoutine

public java.util.Optional<? extends Routine> lookupRoutine(Schema schema,
                                                           java.lang.String name)

Description copied from interface: Catalog

Gets a routine by unqualified name.

Specified by:

lookupRoutine in interface Catalog

name - Name

Returns:

Routine.

lookupSchema

public java.util.Optional<? extends Schema> lookupSchema(java.lang.String name)

Description copied from interface: Catalog

Gets a schema by name.

Specified by:

lookupSchema in interface Catalog

Parameters:

name - Schema name

Returns:

Schema.

lookupSequence

public java.util.Optional<? extends Sequence> lookupSequence(Schema schema,
                                                             java.lang.String name)

Gets the sequence by unqualified name.

Specified by:

lookupSequence in interface Catalog

name - Name

Returns:

Sequence.

lookupSynonym

public java.util.Optional<? extends Synonym> lookupSynonym(Schema schema,
                                                           java.lang.String name)

Gets the synonym by unqualified name.

Specified by:

lookupSynonym in interface Catalog

name - Name

Returns:

Synonym.

lookupSystemColumnDataType

public java.util.Optional<? extends ColumnDataType> lookupSystemColumnDataType(java.lang.String name)

Description copied from interface: Catalog

Gets the column data types defined by the RDBMS system, by name.

Specified by:

lookupSystemColumnDataType in interface Catalog

Parameters:

name - Column data type name

Returns:

Column data type

lookupTable

public java.util.Optional<? extends Table> lookupTable(Schema schema,
                                                       java.lang.String name)

Description copied from interface: Catalog

Gets a table by unqualified name.

Specified by:

lookupTable in interface Catalog

name - Name

Returns:

Table.

reduce

public <N extends NamedObject> void reduce(java.lang.Class<N> clazz,
                                           Reducer<N> reducer)

Specified by:

reduce in interface Reducible

removeAttribute

public void removeAttribute(java.lang.String name)

Description copied from interface: AttributedObject

Removes an attribute.

Specified by:

removeAttribute in interface AttributedObject

Parameters:

name - Attribute name

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Description copied from interface: AttributedObject

Sets an attribute.

Specified by:

setAttribute in interface AttributedObject

Parameters:

name - Attribute name

value - Attribute value

toUniqueLookupKey

public java.util.List<java.lang.String> toUniqueLookupKey()

Description copied from interface: NamedObject

A value guaranteed to be unique in the database for this object.

Specified by:

toUniqueLookupKey in interface NamedObject