JdbcDirectorySettings (Oracle Spatial and Graph Property Graph)

java.lang.Object
- oracle.pg.rdbms.index.jdbc.JdbcDirectorySettings

```
public class JdbcDirectorySettings
extends Object
```
General directory level settings.
The settings also holds JdbcFileEntrySettings, that can be registered with the directory settings. Note, that when registering them, they are registered under both the complete name and the 3 charecters name suffix.
When creating the settings, it already holds sensible settings, they are: The default JdbcFileEntrySettings uses the file entry settings defaults. The "deletable", ""deleteable.new", and "deletable.new" uses the NoOpFileEntryHandler. The "segments" and "segments.new" uses the OracleFileEntryHandler, FetchOnOpenJdbcIndexInput, and RAMJdbcIndexOutput. The file suffix "fnm" uses the FetchOnOpenJdbcIndexInput, and RAMJdbcIndexOutput. The file suffix "del" and "tmp" uses the OracleFileEntryHandler.

Author:

kimchy

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_FILE_ENTRY` The default file entry settings name that are registered under.
`static long`	`HOUR` A simple constant having the millisecond value of an hour.

Constructor Summary

Constructors
Constructor and Description

JdbcDirectorySettings()
Creates a new instance of the Jdbc directory settings with it's default values initialized.

Constructors
Constructor and Description
`JdbcDirectorySettings()` Creates a new instance of the Jdbc directory settings with it's default values initialized.

Method Summary

Methods
Modifier and Type	Method and Description
`JdbcFileEntrySettings`	`getDefaultFileEntrySettings()` Returns the default file entry handler settings.
`String`	`getDeletedColumnName()` Returns the deleted column name (defaults to deleted_).
`long`	`getDeleteMarkDeletedDelta()` Returns the delta (in millis) for the delete mark deleted.
`Map`	`getFileEntrySettings()` Returns the file entries map.
`JdbcFileEntrySettings`	`getFileEntrySettings(String name)` Returns the file entries according to the name.
`JdbcFileEntrySettings`	`getFileEntrySettingsWithoutDefault(String name)` Same as `getFileEntrySettings(String)`, only returns `null` if no match is found (instead of the default file entry handler settings).
`String`	`getLastModifiedColumnName()` Returns the last modified column name (defaults to lf_).
`Class`	`getLockClass()` Returns the lock class that will be used for locking.
`int`	`getNameColumnLength()` Returns the name column length.
`String`	`getNameColumnName()` Returns the name column name (defaults to name_).
`int`	`getQueryTimeout()` Query timeout applies to Jdbc queries.
`String`	`getSizeColumnName()` Returns the size column name (default to size_).
`int`	`getValueColumnLengthInK()` Returns the value column length (In K).
`String`	`getValueColumnName()` Returns the value column name (defaults to value_).
`void`	`registerFileEntrySettings(String name, JdbcFileEntrySettings fileEntrySettings)` Registers a `JdbcFileEntrySettings` against the given name.
`void`	`setDeletedColumnName(String deletedColumnName)` Sets the deleted column name.
`void`	`setDeleteMarkDeletedDelta(long deleteMarkDeletedDelta)` Sets the delta (in millis) for the delete mark deleted.
`void`	`setLastModifiedColumnName(String lastModifiedColumnName)` Sets the last modified column name.
`void`	`setLockClass(Class lockClass)` Sets the lock class that will be used for locking.
`void`	`setNameColumnLength(int nameColumnLength)` Sets the name column length.
`void`	`setNameColumnName(String nameColumnName)` Sets the name column name.
`void`	`setQueryTimeout(int queryTimeout)` Query timeout applies to Jdbc queries.
`void`	`setSizeColumnName(String sizeColumnName)` Sets the size column name.
`void`	`setValueColumnLengthInK(int valueColumnLengthInK)` Sets the value coumn length (In K).
`void`	`setValueColumnName(String valueColumnName)` Sets the value column name.

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

- Field Detail
  - DEFAULT_FILE_ENTRY
```
public static String DEFAULT_FILE_ENTRY
```
    The default file entry settings name that are registered under.
  - HOUR
```
public static final long HOUR
```
    A simple constant having the millisecond value of an hour.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - JdbcDirectorySettings
```
public JdbcDirectorySettings()
```
    Creates a new instance of the Jdbc directory settings with it's default values initialized.
- Method Detail
  - getDefaultFileEntrySettings
```
public JdbcFileEntrySettings getDefaultFileEntrySettings()
```
    Returns the default file entry handler settings.
  - getDeletedColumnName
```
public String getDeletedColumnName()
```
    Returns the deleted column name (defaults to deleted_).
  - getDeleteMarkDeletedDelta
```
public long getDeleteMarkDeletedDelta()
```
    Returns the delta (in millis) for the delete mark deleted. File entries marked as being deleted will be deleted from the system (using org.apache.lucene.store.jdbc.JdbcDirectory#deleteMarkDeleted if: current_time - deletelMarkDeletedDelta < Time File Entry Marked as Deleted.
  - getFileEntrySettings
```
public Map getFileEntrySettings()
```
    Returns the file entries map. Please don't change it during runtime.
  - getFileEntrySettings
```
public JdbcFileEntrySettings getFileEntrySettings(String name)
```
    Returns the file entries according to the name. If a direct match is found, it's registered JdbcFileEntrySettings is returned. If one is registered against the last 3 charecters, then it is returned. If none is found, the default file entry handler is returned.
  - getFileEntrySettingsWithoutDefault
```
public JdbcFileEntrySettings getFileEntrySettingsWithoutDefault(String name)
```
    Same as getFileEntrySettings(String), only returns null if no match is found (instead of the default file entry handler settings).
  - getLastModifiedColumnName
```
public String getLastModifiedColumnName()
```
    Returns the last modified column name (defaults to lf_).
  - getLockClass
```
public Class getLockClass()
```
    Returns the lock class that will be used for locking.
  - getNameColumnLength
```
public int getNameColumnLength()
```
    Returns the name column length.
  - getNameColumnName
```
public String getNameColumnName()
```
    Returns the name column name (defaults to name_).
  - getQueryTimeout
```
public int getQueryTimeout()
```
    Query timeout applies to Jdbc queries.
  - getSizeColumnName
```
public String getSizeColumnName()
```
    Returns the size column name (default to size_).
  - getValueColumnLengthInK
```
public int getValueColumnLengthInK()
```
    Returns the value column length (In K).
  - getValueColumnName
```
public String getValueColumnName()
```
    Returns the value column name (defaults to value_).
  - registerFileEntrySettings
```
public void registerFileEntrySettings(String name,
                             JdbcFileEntrySettings fileEntrySettings)
```
    Registers a JdbcFileEntrySettings against the given name. The name can be the full name of the file, or it's 3 charecters suffix.
  - setDeletedColumnName
```
public void setDeletedColumnName(String deletedColumnName)
```
    Sets the deleted column name.
  - setDeleteMarkDeletedDelta
```
public void setDeleteMarkDeletedDelta(long deleteMarkDeletedDelta)
```
    Sets the delta (in millis) for the delete mark deleted. File entries marked as being deleted will be deleted from the system (using org.apache.lucene.store.jdbc.JdbcDirectory#deleteMarkDeleted if: current_time - deletelMarkDeletedDelta < Time File Entry Marked as Deleted.
  - setLastModifiedColumnName
```
public void setLastModifiedColumnName(String lastModifiedColumnName)
```
    Sets the last modified column name.
  - setLockClass
```
public void setLockClass(Class lockClass)
```
    Sets the lock class that will be used for locking.
  - setNameColumnLength
```
public void setNameColumnLength(int nameColumnLength)
```
    Sets the name column length.
  - setNameColumnName
```
public void setNameColumnName(String nameColumnName)
```
    Sets the name column name.
  - setQueryTimeout
```
public void setQueryTimeout(int queryTimeout)
```
    Query timeout applies to Jdbc queries.
  - setSizeColumnName
```
public void setSizeColumnName(String sizeColumnName)
```
    Sets the size column name.
  - setValueColumnLengthInK
```
public void setValueColumnLengthInK(int valueColumnLengthInK)
```
    Sets the value coumn length (In K).
  - setValueColumnName
```
public void setValueColumnName(String valueColumnName)
```
    Sets the value column name.

Class JdbcDirectorySettings

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_FILE_ENTRY

HOUR

Constructor Detail

JdbcDirectorySettings

Method Detail

getDefaultFileEntrySettings

getDeletedColumnName

getDeleteMarkDeletedDelta

getFileEntrySettings

getFileEntrySettings

getFileEntrySettingsWithoutDefault

getLastModifiedColumnName

getLockClass

getNameColumnLength

getNameColumnName

getQueryTimeout

getSizeColumnName

getValueColumnLengthInK

getValueColumnName

registerFileEntrySettings

setDeletedColumnName

setDeleteMarkDeletedDelta

setLastModifiedColumnName

setLockClass

setNameColumnLength

setNameColumnName

setQueryTimeout

setSizeColumnName

setValueColumnLengthInK

setValueColumnName