SchemaCrawlerOptions (SchemaCrawler API 14.17.05 API)

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

Constructor Summary

Constructors
Constructor and Description

SchemaCrawlerOptions()
Default options.

Constructors
Constructor and Description
`SchemaCrawlerOptions()` Default options.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getChildTableFilterDepth()`
`InclusionRule`	`getColumnInclusionRule()` Gets the column inclusion rule.
`InclusionRule`	`getGrepColumnInclusionRule()` Gets the column inclusion rule for grep.
`InclusionRule`	`getGrepDefinitionInclusionRule()` Gets the definitions inclusion rule for grep.
`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`	`isHideEmptyTables()` If infolevel=maximum, this option will remove empty tables (that is, tables with no rows of data) from the catalog.
`void`	`setChildTableFilterDepth(int childTableFilterDepth)`
`void`	`setColumnInclusionRule(InclusionRule columnInclusionRule)` Sets the column inclusion rule.
`void`	`setGrepColumnInclusionRule(InclusionRule grepColumnInclusionRule)` Sets the column inclusion rule for grep.
`void`	`setGrepDefinitionInclusionRule(InclusionRule grepDefinitionInclusionRule)` Sets the definition inclusion rule for grep.
`void`	`setGrepInvertMatch(boolean grepInvertMatch)` Set whether to invert matches.
`void`	`setGrepOnlyMatching(boolean grepOnlyMatching)` Whether grep includes show foreign keys that reference other non-matching tables.
`void`	`setGrepRoutineColumnInclusionRule(InclusionRule grepRoutineColumnInclusionRule)` Sets the routine column inclusion rule for grep.
`void`	`setHideEmptyTables(boolean hideEmptyTables)` If infolevel=maximum, this option will remove empty tables (that is, tables with no rows of data) from the catalog.
`void`	`setParentTableFilterDepth(int parentTableFilterDepth)`
`void`	`setRoutineColumnInclusionRule(InclusionRule routineColumnInclusionRule)` Sets the routine column inclusion rule.
`void`	`setRoutineInclusionRule(InclusionRule routineInclusionRule)` Sets the routine inclusion rule.
`void`	`setRoutineTypes(java.util.Collection<RoutineType> routineTypes)`
`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`	`setSequenceInclusionRule(InclusionRule sequenceInclusionRule)` Sets the sequence inclusion rule.
`void`	`setSynonymInclusionRule(InclusionRule synonymInclusionRule)` Sets the synonym inclusion rule.
`void`	`setTableInclusionRule(InclusionRule tableInclusionRule)` Sets the table inclusion rule.
`void`	`setTableNamePattern(java.lang.String tableNamePattern)` Sets the table name pattern, using the JDBC syntax for wildcards (_ and *).
`void`	`setTableTypes(java.util.Collection<java.lang.String> tableTypes)` Sets table types requested for output from a collection of table types.
`void`	`setTitle(java.lang.String title)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SchemaCrawlerOptions
```
public SchemaCrawlerOptions()
```
    Default options.
- Method Detail
  - getChildTableFilterDepth
```
public int getChildTableFilterDepth()
```
  - 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.
  - getGrepDefinitionInclusionRule
```
public InclusionRule getGrepDefinitionInclusionRule()
```
    Gets the definitions inclusion rule for grep.
    
    Returns:
    
    Definitions inclusion rule for grep.
  - getGrepRoutineColumnInclusionRule
```
public 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()
```
  - isHideEmptyTables
```
public boolean isHideEmptyTables()
```
    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
  - setChildTableFilterDepth
```
public void setChildTableFilterDepth(int childTableFilterDepth)
```
  - 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:
    
    grepColumnInclusionRule - Column inclusion rule for grep
  - setGrepDefinitionInclusionRule
```
public void setGrepDefinitionInclusionRule(InclusionRule grepDefinitionInclusionRule)
```
    Sets the definition inclusion rule for grep.
    
    Parameters:
    
    grepDefinitionInclusionRule - Definition inclusion rule for grep
  - setGrepInvertMatch
```
public void setGrepInvertMatch(boolean grepInvertMatch)
```
    Set whether to invert matches.
    
    Parameters:
    
    grepInvertMatch - Whether to invert matches.
  - setGrepOnlyMatching
```
public void setGrepOnlyMatching(boolean grepOnlyMatching)
```
    Whether grep includes show foreign keys that reference other non-matching tables.
    
    Parameters:
    
    grepOnlyMatching - Whether grep includes show foreign keys that reference other non-matching tables.
  - setGrepRoutineColumnInclusionRule
```
public void setGrepRoutineColumnInclusionRule(InclusionRule grepRoutineColumnInclusionRule)
```
    Sets the routine column inclusion rule for grep.
    
    Parameters:
    
    grepRoutineColumnInclusionRule - Routine column inclusion rule for grep
  - setHideEmptyTables
```
public void setHideEmptyTables(boolean hideEmptyTables)
```
    If infolevel=maximum, this option will remove empty tables (that is, tables with no rows of data) from the catalog.
    
    Parameters:
    
    hideEmptyTables - Whether to hide empty tables
  - setParentTableFilterDepth
```
public void setParentTableFilterDepth(int parentTableFilterDepth)
```
  - setRoutineColumnInclusionRule
```
public void setRoutineColumnInclusionRule(InclusionRule routineColumnInclusionRule)
```
    Sets the routine column inclusion rule.
    
    Parameters:
    
    routineColumnInclusionRule - Routine column inclusion rule
  - setRoutineInclusionRule
```
public void setRoutineInclusionRule(InclusionRule routineInclusionRule)
```
    Sets the routine inclusion rule.
    
    Parameters:
    
    routineInclusionRule - Routine inclusion rule
  - setRoutineTypes
```
public void setRoutineTypes(java.util.Collection<RoutineType> routineTypes)
```
  - 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.
  - setSequenceInclusionRule
```
public void setSequenceInclusionRule(InclusionRule sequenceInclusionRule)
```
    Sets the sequence inclusion rule.
    
    Parameters:
    
    sequenceInclusionRule - Sequence inclusion rule
  - setSynonymInclusionRule
```
public void setSynonymInclusionRule(InclusionRule synonymInclusionRule)
```
    Sets the synonym inclusion rule.
    
    Parameters:
    
    synonymInclusionRule - Synonym inclusion rule
  - setTableInclusionRule
```
public void setTableInclusionRule(InclusionRule tableInclusionRule)
```
    Sets the table inclusion rule.
    
    Parameters:
    
    tableInclusionRule - Table inclusion rule
  - setTableNamePattern
```
public void setTableNamePattern(java.lang.String tableNamePattern)
```
    Sets the table name pattern, using the JDBC syntax for wildcards (_ and *). The table name pattern is case-sensitive, and matches just the table name - not the fully qualified table name. The table name pattern restricts the tables retrieved at an early stage in the retrieval process, so it must be used only when performance needs to be tuned. A null value indicates do not take table pattern into account.
    
    Parameters:
    
    tableNamePattern - Table name pattern, null is allowed
  - setTableTypes
```
public void setTableTypes(java.util.Collection<java.lang.String> tableTypes)
```
    Sets table types requested for output from a collection of table types. For example: TABLE,VIEW,SYSTEM_TABLE,GLOBAL TEMPORARY,ALIAS,SYNONYM
    
    Parameters:
    
    tableTypes - Collection of table types. Can be null if all supported table types are requested.
  - setTitle
```
public void setTitle(java.lang.String title)
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class SchemaCrawlerOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SchemaCrawlerOptions

Method Detail

getChildTableFilterDepth

getColumnInclusionRule

getGrepColumnInclusionRule

getGrepDefinitionInclusionRule

getGrepRoutineColumnInclusionRule

getParentTableFilterDepth

getRoutineColumnInclusionRule

getRoutineInclusionRule

getRoutineTypes

getSchemaInclusionRule

getSchemaInfoLevel

getSequenceInclusionRule

getSynonymInclusionRule

getTableInclusionRule

getTableNamePattern

getTableTypes

getTitle

isGrepColumns

isGrepDefinitions

isGrepInvertMatch

isGrepOnlyMatching

isGrepRoutineColumns

isHideEmptyTables

setChildTableFilterDepth

setColumnInclusionRule

setGrepColumnInclusionRule

setGrepDefinitionInclusionRule

setGrepInvertMatch

setGrepOnlyMatching

setGrepRoutineColumnInclusionRule

setHideEmptyTables

setParentTableFilterDepth

setRoutineColumnInclusionRule

setRoutineInclusionRule

setRoutineTypes

setSchemaInclusionRule

setSchemaInfoLevel

setSequenceInclusionRule

setSynonymInclusionRule

setTableInclusionRule

setTableNamePattern

setTableTypes

setTitle

toString