StructureTableOptions (JChem Base API documentation (c) 1998-2020 ChemAxon Ltd.)

java.lang.Object
- chemaxon.jchem.db.StructureTableOptions

All Implemented Interfaces:

TableTypeConstants
```
@PublicAPI
public class StructureTableOptions
extends java.lang.Object
implements TableTypeConstants
```
Class for storing options for structure table creation.

Since:

JChem 5.0

Version:

6.1

Author:

JChem Base team, Szilard Dorant, Monika Vigula

Field Summary
- Fields inherited from interface chemaxon.jchem.db.TableTypeConstants
  FP_DEFAULT_BITS_PER_PATTERN, FP_DEFAULT_LENGTH_IN_INTS, FP_DEFAULT_PATTERN_LENGTH, MYSQL_DEFAULT_TABLE_TYPE, MYSQL_FORCE_INNO_DB, MYSQL_FORCE_MYISAM, TABLE_TYPE_ANY_STRUCTURES, TABLE_TYPE_DEFAULT, TABLE_TYPE_EXPLANATIONS, TABLE_TYPE_IS_NOT_SUPPORTED, TABLE_TYPE_MARKUSH_LIBRARIES, TABLE_TYPE_MOLECULES, TABLE_TYPE_NAMES, TABLE_TYPE_QUERY_STRUCTURES, TABLE_TYPE_REACTIONS

Constructor Summary

Constructors
Constructor and Description
`StructureTableOptions(java.lang.String name)` Creates structure table options with the specified table name and default table type (`TableTypeConstants.TABLE_TYPE_DEFAULT`).
`StructureTableOptions(java.lang.String name, int tableType)` Creates structure table options with the specified name and table type.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`chemaxon.jchem.base.storage.cache.CacheUpdaterType`	`getCacheUpdaterType()` Gets the method to update cache.
`java.util.Map<java.lang.String,java.lang.String>`	`getChemTermColsConfig()` Gets a map having as keys the names of columns which are assigned a value (during structure import and update).
`java.lang.String`	`getExtraColumnDefinitions()` Gets the definitions of additional columns.
`int`	`getFpNumberOfEdges()` Gets he maximum pattern length.
`int`	`getFpNumberOfInts()` Gets the length of the chemical hashed fingerprint.
`int`	`getFpNumberOfOnes()` Gets the number of bits set for patterns.
`int`	`getMysqlTableType()` Gets the table engine for MySql.
`java.lang.String`	`getName()` Gets the table name.
`java.lang.String`	`getStandardizerConfig()` Gets the standardization configuration string.
`StrucFPConfig`	`getStructuralKeyConfig()` Gets the structural key configuration.
`int`	`getStructureColumnType()` Gets the type of the `cd_structure` column.
`int`	`getTableType()` Gets the table name.
`chemaxon.sss.search.options.TautomerTransformationMode`	`getTautomerEqualityMode()`
`boolean`	`isAbsoluteStereo()` Gets whether the structures should be treated as absolute stereo during database search.
`boolean`	`isDuplicateFiltering()` Gets the duplicate filtering option.
`boolean`	`isTautomerDuplicateChecking()` Gets whether tautomers are considered during DUPLICATE search.
`void`	`setAbsoluteStereo(boolean absoluteStereo)` Specifies if structures should be treated as absolute stereo during database search.
`void`	`setCacheUpdaterType(chemaxon.jchem.base.storage.cache.CacheUpdaterType cacheUpdaterType)` Sets the cache update type.
`void`	`setChemTermColsConfig(java.util.Map<java.lang.String,java.lang.String> chemTermColsConfig)` Sets the map having as keys the names of columns which must be assigned a value (during structure import and update).
`void`	`setDuplicateFiltering(boolean duplicateFiltering)` Specifies the duplicate filtering option.
`void`	`setExtraColumnDefinitions(java.lang.String extraColumnDefinitions)` Sets the definitions of additional columns.
`void`	`setFpNumberOfBonds(int fp_numberOfBonds)` Sets the maximum pattern length.
`void`	`setFpNumberOfInts(int fp_numberOfInts)` Sets the length of the chemical hashed fingerprint in `int` size units (bit count / 32).
`void`	`setFpNumberOfOnes(int fp_numberOfOnes)` Sets the number of bits to be set for patterns.
`void`	`setMysqlTableType(int mysqlTableType)` Specifies table engine for MySql.
`void`	`setName(java.lang.String name)`
`void`	`setStandardizerConfig(java.lang.String standardizerConfig)` Sets the standardization configuration string (XML or simple action string).
`void`	`setStructuralKeyConfig(StrucFPConfig structuralKeyConfig)` Sets the structural key configuration.
`void`	`setStructureColumnType(int structureColumnType)` Sets the structure column type.
`void`	`setTableType(int tableType)`
`void`	`setTautomerDuplicateChecking(boolean tautomerDuplicateChecking)` Specifies if tautomers should be considered during DUPLICATE search, e.g.
`void`	`setTautomerEqualityMode(chemaxon.sss.search.options.TautomerTransformationMode tautomerEqualityMode)`

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

- Constructor Detail
  - StructureTableOptions
```
public StructureTableOptions(java.lang.String name,
                             int tableType)
```
    Creates structure table options with the specified name and table type.
    
    Parameters:
    
    name - table name
    
    tableType - table type
  - StructureTableOptions
```
public StructureTableOptions(java.lang.String name)
```
    Creates structure table options with the specified table name and default table type (TableTypeConstants.TABLE_TYPE_DEFAULT).
    
    Parameters:
    
    name - table name
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Gets the table name.
    
    Returns:
    
    the table name
  - getFpNumberOfInts
```
public int getFpNumberOfInts()
```
    Gets the length of the chemical hashed fingerprint.
    
    Returns:
    
    the length of the chemical hashed fingerprint in int size units
  - getFpNumberOfOnes
```
public int getFpNumberOfOnes()
```
    Gets the number of bits set for patterns.
    
    Returns:
    
    the number of bits set for patterns
  - getFpNumberOfEdges
```
public int getFpNumberOfEdges()
```
    Gets he maximum pattern length.
    
    Returns:
    
    the maximum pattern length
  - getStandardizerConfig
```
public java.lang.String getStandardizerConfig()
```
    Gets the standardization configuration string.
    
    Returns:
    
    the standardization configuration string
  - isAbsoluteStereo
```
public boolean isAbsoluteStereo()
```
    Gets whether the structures should be treated as absolute stereo during database search.
    
    Returns:
    
    structures should be treated as absolute stereo during database search
  - getStructuralKeyConfig
```
public StrucFPConfig getStructuralKeyConfig()
```
    Gets the structural key configuration.
    
    Returns:
    
    the structural key configuration
  - getChemTermColsConfig
```
public java.util.Map<java.lang.String,java.lang.String> getChemTermColsConfig()
```
    Gets a map having as keys the names of columns which are assigned a value (during structure import and update). The values assigned to the columns are calculated using the chemical terms expressions contained in the map as values.
    
    Returns:
    
    a map having as keys the names of columns which are assigned a value
  - getTableType
```
public int getTableType()
```
    Gets the table name.
    
    Returns:
    
    the table type
  - isTautomerDuplicateChecking
```
public boolean isTautomerDuplicateChecking()
```
    Gets whether tautomers are considered during DUPLICATE search.
    
    Returns:
    
    returns whether tautomers are considered during DUPLICATE search, e.g. importing with duplicate checking
  - getExtraColumnDefinitions
```
public java.lang.String getExtraColumnDefinitions()
```
    Gets the definitions of additional columns.
    
    Returns:
    
    the definitions of additional columns
  - getStructureColumnType
```
public int getStructureColumnType()
```
    Gets the type of the cd_structure column.
    
    Returns:
    
    the type of the cd_structure column
  - getMysqlTableType
```
public int getMysqlTableType()
```
    Gets the table engine for MySql.
    
    Returns:
    
    the table engine for MySql.
  - isDuplicateFiltering
```
public boolean isDuplicateFiltering()
```
    Gets the duplicate filtering option.
    
    Returns:
    
    the duplicate filtering option
  - getCacheUpdaterType
```
public chemaxon.jchem.base.storage.cache.CacheUpdaterType getCacheUpdaterType()
```
    Gets the method to update cache.
    
    Returns:
    
    the method to update cache
  - setFpNumberOfInts
```
public void setFpNumberOfInts(int fp_numberOfInts)
```
    Sets the length of the chemical hashed fingerprint in int size units (bit count / 32). The value should be greater than or equal to 8.
    
    Parameters:
    
    fp_numberOfInts - the chemical hashed fingerprint in int size units
  - setFpNumberOfOnes
```
public void setFpNumberOfOnes(int fp_numberOfOnes)
```
    Sets the number of bits to be set for patterns.
    
    Parameters:
    
    fp_numberOfOnes - the number of bits to set
  - setFpNumberOfBonds
```
public void setFpNumberOfBonds(int fp_numberOfBonds)
```
    Sets the maximum pattern length. The value should be between 2 and 10.
    
    Parameters:
    
    fp_numberOfBonds - maximum pattern length
  - setStandardizerConfig
```
public void setStandardizerConfig(java.lang.String standardizerConfig)
```
    Sets the standardization configuration string (XML or simple action string).
    
    Parameters:
    
    standardizerConfig - the standardization configuration string
  - setAbsoluteStereo
```
public void setAbsoluteStereo(boolean absoluteStereo)
```
    Specifies if structures should be treated as absolute stereo during database search. This overrides the original state of the chiral flag.
    
    Parameters:
    
    absoluteStereo - whether structures should be treated as absolute stereo during database search
  - setStructuralKeyConfig
```
public void setStructuralKeyConfig(StrucFPConfig structuralKeyConfig)
```
    Sets the structural key configuration.
    
    Parameters:
    
    structuralKeyConfig - the structural key configuration
    
    See Also:
    
    StrucFPConfig
  - setChemTermColsConfig
```
public void setChemTermColsConfig(java.util.Map<java.lang.String,java.lang.String> chemTermColsConfig)
```
    Sets the map having as keys the names of columns which must be assigned a value (during structure import and update). The values assigned to the columns are calculated using the chemical terms expressions contained in the map as values.
    
    Parameters:
    
    chemTermColsConfig - the chemical terms expression
  - setTautomerDuplicateChecking
```
public void setTautomerDuplicateChecking(boolean tautomerDuplicateChecking)
```
    Specifies if tautomers should be considered during DUPLICATE search, e.g. importing with duplicate checking.
    If set to true the import / insert of structures requires some additional CPU time.
    
    Parameters:
    
    tautomerDuplicateChecking - whether tautomers should be considered during DUPLICATE search or import.
  - setExtraColumnDefinitions
```
public void setExtraColumnDefinitions(java.lang.String extraColumnDefinitions)
```
    Sets the definitions of additional columns. The syntax of the columnDefs field
    - starts with a comma
    - contains column definitions separated by comma
    - see the SQL CREATE statement for legal column definitions.
    Parameters:
    
    extraColumnDefinitions - the definitions of additional columns
  - setStructureColumnType
```
public void setStructureColumnType(int structureColumnType)
```
    Sets the structure column type.
    
    Parameters:
    
    structureColumnType - the structure column type
  - setMysqlTableType
```
public void setMysqlTableType(int mysqlTableType)
```
    Specifies table engine for MySql.
    
    Parameters:
    
    mysqlTableType - the mysql table type
    
    See Also:
    
    TableTypeConstants.MYSQL_DEFAULT_TABLE_TYPE, TableTypeConstants.MYSQL_FORCE_INNO_DB, TableTypeConstants.MYSQL_FORCE_MYISAM
  - setDuplicateFiltering
```
public void setDuplicateFiltering(boolean duplicateFiltering)
```
    Specifies the duplicate filtering option.
    
    Parameters:
    
    duplicateFiltering - duplicate filtering option
  - setCacheUpdaterType
```
public void setCacheUpdaterType(chemaxon.jchem.base.storage.cache.CacheUpdaterType cacheUpdaterType)
```
    Sets the cache update type.
    
    Parameters:
    
    cacheUpdaterType - the method to update cache
  - setName
```
public void setName(java.lang.String name)
```
    Parameters:
    
    name - the name to set
  - setTableType
```
public void setTableType(int tableType)
```
    Parameters:
    
    tableType - the tableType to set
  - getTautomerEqualityMode
```
@Beta
public chemaxon.sss.search.options.TautomerTransformationMode getTautomerEqualityMode()
```
  - setTautomerEqualityMode
```
@Beta
public void setTautomerEqualityMode(chemaxon.sss.search.options.TautomerTransformationMode tautomerEqualityMode)
```

Class StructureTableOptions

Field Summary

Fields inherited from interface chemaxon.jchem.db.TableTypeConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StructureTableOptions

StructureTableOptions

Method Detail

getName

getFpNumberOfInts

getFpNumberOfOnes

getFpNumberOfEdges

getStandardizerConfig

isAbsoluteStereo

getStructuralKeyConfig

getChemTermColsConfig

getTableType

isTautomerDuplicateChecking

getExtraColumnDefinitions

getStructureColumnType

getMysqlTableType

isDuplicateFiltering

getCacheUpdaterType

setFpNumberOfInts

setFpNumberOfOnes

setFpNumberOfBonds

setStandardizerConfig

setAbsoluteStereo

setStructuralKeyConfig

setChemTermColsConfig

setTautomerDuplicateChecking

setExtraColumnDefinitions

setStructureColumnType

setMysqlTableType

setDuplicateFiltering

setCacheUpdaterType

setName

setTableType

getTautomerEqualityMode

setTautomerEqualityMode