schemacrawler.schemacrawler
Class SchemaCrawlerOptions

java.lang.Object
  schemacrawler.schemacrawler.SchemaCrawlerOptions

All Implemented Interfaces:

java.io.Serializable, Options

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

SchemaCrawler options.

Author:

Sualeh Fatehi

See Also:

Serialized Form

Field Summary

static java.lang.String

DEFAULT_TABLE_TYPES

Constructor Summary

SchemaCrawlerOptions()
Default options.

SchemaCrawlerOptions(Config config)
Options from properties.

Method Summary

InclusionRule	getCatalogInclusionRule() Gets the catalog inclusion rule.
InclusionRule	getColumnInclusionRule() Gets the column inclusion rule.
InclusionRule	getGrepColumnInclusionRule() Gets the column inclusion rule for grep.
InclusionRule	getGrepProcedureColumnInclusionRule() Gets the procedure column rule for grep.
InformationSchemaViews	getInformationSchemaViews() Gets the information schema views.
InclusionRule	getProcedureColumnInclusionRule() Gets the procedure column rule.
InclusionRule	getProcedureInclusionRule() Gets the procedure inclusion rule.
InclusionRule	getSchemaInclusionRule() Gets the schema inclusion rule.
SchemaInfoLevel	getSchemaInfoLevel() Gets the schema information level, identifying to what level the schema should be crawled.
InclusionRule	getTableInclusionRule() Gets the table inclusion rule.
TableType[]	getTableTypes() Get the table types.
boolean	isAlphabeticalSortForForeignKeys() Whether foreign keys are alphabetically sorted.
boolean	isAlphabeticalSortForIndexes() Whether indexes are alphabetically sorted.
boolean	isAlphabeticalSortForProcedureColumns() Whether procedure columns are alphabetically sorted.
boolean	isAlphabeticalSortForTableColumns() Whether table columns are alphabetically sorted.
boolean	isAlphabeticalSortForTables() Whether tables are alphabetically sorted.
boolean	isGrepInvertMatch() Whether to invert matches.
boolean	isShowStoredProcedures() Whether stored procedures are output.
void	setAlphabeticalSortForForeignKeys(boolean alphabeticalSort) Sets whether foreign keys should be alphabetically sorted.
void	setAlphabeticalSortForIndexes(boolean alphabeticalSort) Sets whether indexes should be alphabetically sorted.
void	setAlphabeticalSortForProcedureColumns(boolean alphabeticalSort) Sets whether procedure columns should be alphabetically sorted.
void	setAlphabeticalSortForTableColumns(boolean alphabeticalSort) Sets whether table columns should be alphabetically sorted.
void	setAlphabeticalSortForTables(boolean alphabeticalSort) Sets whether tables should be alphabetically sorted.
void	setCatalogInclusionRule(InclusionRule catalogInclusionRule) Sets the catalog inclusion rule.
void	setColumnInclusionRule(InclusionRule columnInclusionRule) Sets the column inclusion rule.
void	setGrepColumnInclusionRule(InclusionRule grepColumnInclusionRule) Sets the column inclusion rule for grep.
void	setGrepInvertMatch(boolean grepInvertMatch) Set whether to invert matches.
void	setGrepProcedureColumnInclusionRule(InclusionRule grepProcedureColumnInclusionRule) Sets the procedure column inclusion rule for grep.
void	setInformationSchemaViews(InformationSchemaViews informationSchemaViews) Sets the information schema views.
void	setProcedureColumnInclusionRule(InclusionRule procedureColumnInclusionRule) Sets the procedure column inclusion rule.
void	setProcedureInclusionRule(InclusionRule procedureInclusionRule) Sets the procedure inclusion rule.
void	setSchemaInclusionRule(InclusionRule schemaInclusionRule) Sets the schema inclusion rule.
void	setSchemaInfoLevel(SchemaInfoLevel schemaInfoLevel) Sets the schema information level, identifying to what level the schema should be crawled.
void	setShowStoredProcedures(boolean showStoredProcedures) Set show stored procedures.
void	setTableInclusionRule(InclusionRule tableInclusionRule) Sets the table inclusion rule.
void	setTableTypes(java.lang.String tableTypesString) Sets table types from a comma-separated list of table types.
void	setTableTypes(TableType[] tableTypesArray) Sets table types from an array of table types.
void	setTableTypesString(java.lang.String tableTypesString) Sets table types from a comma-separated list of table types.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TABLE_TYPES

public static final java.lang.String DEFAULT_TABLE_TYPES

See Also:

Constant Field Values

Constructor Detail

SchemaCrawlerOptions

public SchemaCrawlerOptions()

Default options.

SchemaCrawlerOptions

public SchemaCrawlerOptions(Config config)

Options from properties.

Parameters:

config - Configuration properties

partition - Partition for information schema

Method Detail

getCatalogInclusionRule

public InclusionRule getCatalogInclusionRule()

Gets the catalog inclusion rule.

Returns:

Catalog inclusion rule.

getColumnInclusionRule

public InclusionRule getColumnInclusionRule()

Gets the column inclusion rule.

Returns:

Column inclusion rule.

getGrepColumnInclusionRule

public InclusionRule getGrepColumnInclusionRule()

Gets the column inclusion rule for grep.

Returns:

Column inclusion rule for grep.

getGrepProcedureColumnInclusionRule

public InclusionRule getGrepProcedureColumnInclusionRule()

Gets the procedure column rule for grep.

Returns:

Procedure column rule for grep.

getInformationSchemaViews

public InformationSchemaViews getInformationSchemaViews()

Gets the information schema views.

Returns:

Information schema views.

getProcedureColumnInclusionRule

public InclusionRule getProcedureColumnInclusionRule()

Gets the procedure column rule.

Returns:

Procedure column rule.

getProcedureInclusionRule

public InclusionRule getProcedureInclusionRule()

Gets the procedure inclusion rule.

Returns:

Procedure inclusion rule.

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.

getTableInclusionRule

public InclusionRule getTableInclusionRule()

Gets the table inclusion rule.

Returns:

Table inclusion rule.

getTableTypes

public TableType[] getTableTypes()

Get the table types.

Returns:

Table types

isAlphabeticalSortForForeignKeys

public boolean isAlphabeticalSortForForeignKeys()

Whether foreign keys are alphabetically sorted.

Returns:

Whether foreign keys are alphabetically sorted

isAlphabeticalSortForIndexes

public boolean isAlphabeticalSortForIndexes()

Whether indexes are alphabetically sorted.

Returns:

Whether indexes are alphabetically sorted

isAlphabeticalSortForProcedureColumns

public boolean isAlphabeticalSortForProcedureColumns()

Whether procedure columns are alphabetically sorted.

Returns:

Whether procedure columns are alphabetically sorted

isAlphabeticalSortForTableColumns

public boolean isAlphabeticalSortForTableColumns()

Whether table columns are alphabetically sorted.

Returns:

Whether table columns are alphabetically sorted

isAlphabeticalSortForTables

public boolean isAlphabeticalSortForTables()

Whether tables are alphabetically sorted.

Returns:

Whether tables are alphabetically sorted

isGrepInvertMatch

public boolean isGrepInvertMatch()

Whether to invert matches.

Returns:

Whether to invert matches.

isShowStoredProcedures

public boolean isShowStoredProcedures()

Whether stored procedures are output.

Returns:

Whether stored procedures are output

setAlphabeticalSortForForeignKeys

public void setAlphabeticalSortForForeignKeys(boolean alphabeticalSort)

Sets whether foreign keys should be alphabetically sorted.

Parameters:

alphabeticalSort - Alphabetical sort

setAlphabeticalSortForIndexes

public void setAlphabeticalSortForIndexes(boolean alphabeticalSort)

Sets whether indexes should be alphabetically sorted.

Parameters:

alphabeticalSort - Alphabetical sort

setAlphabeticalSortForProcedureColumns

public void setAlphabeticalSortForProcedureColumns(boolean alphabeticalSort)

Sets whether procedure columns should be alphabetically sorted.

Parameters:

alphabeticalSort - Alphabetical sort

setAlphabeticalSortForTableColumns

public void setAlphabeticalSortForTableColumns(boolean alphabeticalSort)

Sets whether table columns should be alphabetically sorted.

Parameters:

alphabeticalSort - Alphabetical sort

setAlphabeticalSortForTables

public void setAlphabeticalSortForTables(boolean alphabeticalSort)

Sets whether tables should be alphabetically sorted.

Parameters:

alphabeticalSort - Alphabetical sort

setCatalogInclusionRule

public void setCatalogInclusionRule(InclusionRule catalogInclusionRule)

Sets the catalog inclusion rule.

Parameters:

catalogInclusionRule - Catalog inclusion rule

setColumnInclusionRule

public void setColumnInclusionRule(InclusionRule columnInclusionRule)

Sets the column inclusion rule.

Parameters:

columnInclusionRule - Column inclusion rule

setGrepColumnInclusionRule

public void setGrepColumnInclusionRule(InclusionRule grepColumnInclusionRule)

Sets the column inclusion rule for grep.

Parameters:

columnInclusionRule - Column inclusion rule for grep

setGrepInvertMatch

public void setGrepInvertMatch(boolean grepInvertMatch)

Set whether to invert matches.

Parameters:

invertMatch - Whether to invert matches.

setGrepProcedureColumnInclusionRule

public void setGrepProcedureColumnInclusionRule(InclusionRule grepProcedureColumnInclusionRule)

Sets the procedure column inclusion rule for grep.

Parameters:

procedureColumnInclusionRule - Procedure column inclusion rule for grep

setInformationSchemaViews

public void setInformationSchemaViews(InformationSchemaViews informationSchemaViews)

Sets the information schema views.

Parameters:

informationSchemaViews - Information schema views.

setProcedureColumnInclusionRule

public void setProcedureColumnInclusionRule(InclusionRule procedureColumnInclusionRule)

Sets the procedure column inclusion rule.

Parameters:

procedureColumnInclusionRule - Procedure column inclusion rule

setProcedureInclusionRule

public void setProcedureInclusionRule(InclusionRule procedureInclusionRule)

Sets the procedure inclusion rule.

Parameters:

procedureInclusionRule - Procedure inclusion rule

setSchemaInclusionRule

public void setSchemaInclusionRule(InclusionRule schemaInclusionRule)

Sets the schema inclusion rule.

Parameters:

schemaInclusionRule - Schema inclusion rule

setSchemaInfoLevel

public void setSchemaInfoLevel(SchemaInfoLevel schemaInfoLevel)

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

Parameters:

schemaInfoLevel - Schema information level.

setShowStoredProcedures

public void setShowStoredProcedures(boolean showStoredProcedures)

Set show stored procedures.

Parameters:

showStoredProcedures - Show stored procedures

setTableInclusionRule

public void setTableInclusionRule(InclusionRule tableInclusionRule)

Sets the table inclusion rule.

Parameters:

tableInclusionRule - Table inclusion rule

setTableTypes

public void setTableTypes(java.lang.String tableTypesString)

Sets table types from a comma-separated list of table types. For example: TABLE,VIEW,SYSTEM_TABLE,GLOBAL_TEMPORARY,LOCAL_TEMPORARY,ALIAS ,SYNONYM

Parameters:

tableTypesString - Comma-separated list of table types.

setTableTypes

public void setTableTypes(TableType[] tableTypesArray)

Sets table types from an array of table types.

Parameters:

tableTypesArray - Array of table types.

setTableTypesString

public void setTableTypesString(java.lang.String tableTypesString)

Sets table types from a comma-separated list of table types. For example: TABLE,VIEW,SYSTEM_TABLE,GLOBAL_TEMPORARY,LOCAL_TEMPORARY,ALIAS ,SYNONYM

Parameters:

tableTypesString - Comma-separated list of table types.