schemacrawler.schemacrawler

Class SchemaCrawlerOptions

java.lang.Object

schemacrawler.schemacrawler.SchemaCrawlerOptions

All Implemented Interfaces:

Options

public final class SchemaCrawlerOptions
extends java.lang.Object
implements Options

SchemaCrawler options.

Author:

Sualeh Fatehi

Method Summary

Modifier and Type	Method and Description
int	getChildTableFilterDepth()
InclusionRule	getColumnInclusionRule() Gets the column inclusion rule.
java.util.Optional<InclusionRule>	getGrepColumnInclusionRule() Gets the column inclusion rule for grep.
java.util.Optional<InclusionRule>	getGrepDefinitionInclusionRule() Gets the definitions inclusion rule for grep.
java.util.Optional<InclusionRule>	getGrepRoutineColumnInclusionRule() Gets the routine column rule for grep.
int	getParentTableFilterDepth()
InclusionRule	getRoutineColumnInclusionRule() Gets the routine column rule.
InclusionRule	getRoutineInclusionRule() Gets the routine inclusion rule.
java.util.Collection<RoutineType>	getRoutineTypes()
InclusionRule	getSchemaInclusionRule() Gets the schema inclusion rule.
SchemaInfoLevel	getSchemaInfoLevel() Gets the schema information level, identifying to what level the schema should be crawled.
InclusionRule	getSequenceInclusionRule() Gets the sequence inclusion rule.
InclusionRule	getSynonymInclusionRule() Gets the synonym inclusion rule.
InclusionRule	getTableInclusionRule() Gets the table inclusion rule.
java.lang.String	getTableNamePattern() Gets the table name pattern.
java.util.Collection<java.lang.String>	getTableTypes() Returns the table types requested for output.
java.lang.String	getTitle()
boolean	isGrepColumns()
boolean	isGrepDefinitions()
boolean	isGrepInvertMatch() Whether to invert matches.
boolean	isGrepOnlyMatching() Whether grep includes show foreign keys that reference other non-matching tables.
boolean	isGrepRoutineColumns()
boolean	isNoEmptyTables() If infolevel=maximum, this option will remove empty tables (that is, tables with no rows of data) from the catalog.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getChildTableFilterDepth

public int getChildTableFilterDepth()

getColumnInclusionRule

public InclusionRule getColumnInclusionRule()

Gets the column inclusion rule.

Returns:

Column inclusion rule.

getGrepColumnInclusionRule

public java.util.Optional<InclusionRule> getGrepColumnInclusionRule()

Gets the column inclusion rule for grep.

Returns:

Column inclusion rule for grep.

getGrepDefinitionInclusionRule

public java.util.Optional<InclusionRule> getGrepDefinitionInclusionRule()

Gets the definitions inclusion rule for grep.

Returns:

Definitions inclusion rule for grep.

getGrepRoutineColumnInclusionRule

public java.util.Optional<InclusionRule> getGrepRoutineColumnInclusionRule()

Gets the routine column rule for grep.

Returns:

Routine column rule for grep.

getParentTableFilterDepth

public int getParentTableFilterDepth()

getRoutineColumnInclusionRule

public InclusionRule getRoutineColumnInclusionRule()

Gets the routine column rule.

Returns:

Routine column rule.

getRoutineInclusionRule

public InclusionRule getRoutineInclusionRule()

Gets the routine inclusion rule.

Returns:

Routine inclusion rule.

getRoutineTypes

public java.util.Collection<RoutineType> getRoutineTypes()

getSchemaInclusionRule

public InclusionRule getSchemaInclusionRule()

Gets the schema inclusion rule.

Returns:

Schema inclusion rule.

getSchemaInfoLevel

public SchemaInfoLevel getSchemaInfoLevel()

Gets the schema information level, identifying to what level the schema should be crawled.

Returns:

Schema information level.

getSequenceInclusionRule

public InclusionRule getSequenceInclusionRule()

Gets the sequence inclusion rule.

Returns:

Sequence inclusion rule.

getSynonymInclusionRule

public InclusionRule getSynonymInclusionRule()

Gets the synonym inclusion rule.

Returns:

Synonym inclusion rule.

getTableInclusionRule

public InclusionRule getTableInclusionRule()

Gets the table inclusion rule.

Returns:

Table inclusion rule.

getTableNamePattern

public java.lang.String getTableNamePattern()

Gets the table name pattern. A null value indicates do not take table pattern into account.

Returns:

Table name pattern

getTableTypes

public java.util.Collection<java.lang.String> getTableTypes()

Returns the table types requested for output. This can be null, if all supported table types are required in the output.

Returns:

All table types requested for output

getTitle

public java.lang.String getTitle()

isGrepColumns

public boolean isGrepColumns()

isGrepDefinitions

public boolean isGrepDefinitions()

isGrepInvertMatch

public boolean isGrepInvertMatch()

Whether to invert matches.

Returns:

Whether to invert matches.

isGrepOnlyMatching

public boolean isGrepOnlyMatching()

Whether grep includes show foreign keys that reference other non-matching tables.

isGrepRoutineColumns

public boolean isGrepRoutineColumns()

isNoEmptyTables

public boolean isNoEmptyTables()

If infolevel=maximum, this option will remove empty tables (that is, tables with no rows of data) from the catalog.

Returns:

Whether to hide empty tables

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object