JDBCStorableInfo (Carbonado 1.2.3 API)

+
+
All Superinterfaces:
+
StorableInfo<S>
+
+
+
+
```
public interface JDBCStorableInfo<S extends Storable>
+extends StorableInfo<S>
```
+
Contains all the metadata describing a specific Storable type as + needed by JDBCRepository. It extends the regular StorableInfo with + information gathered from the database.
+
Author:
+
Brian S O'Neill
+
See Also:
JDBCStorableIntrospector
+

+ +

Method Summary

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Methods
Modifier and Type	Method and Description
`java.util.Map<java.lang.String,JDBCStorableProperty<S>>`	`getAllProperties()` + Returns all the storable properties in an unmodifiable map. +
`java.lang.String`	`getCatalogName()` + Returns the optional catalog name for the Storable. +
`java.util.Map<java.lang.String,JDBCStorableProperty<S>>`	`getDataProperties()` + Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties. +
`java.util.Map<java.lang.String,JDBCStorableProperty<S>>`	`getIdentityProperties()` + Returns auto-increment properties which are primary key members. +
`IndexInfo[]`	`getIndexInfo()`
`java.util.Map<java.lang.String,JDBCStorableProperty<S>>`	`getPrimaryKeyProperties()` + Returns a subset of the storable properties in an unmodifiable map + that define the primary key. +
`java.lang.String`	`getQualifiedTableName()` + Returns the qualified table name for the Storable or null if + unsupported. +
`java.lang.String`	`getSchemaName()` + Returns the optional schema name for the Storable. +
`java.lang.String`	`getTableName()` + Returns the table name for the Storable or null if unsupported. +
`JDBCStorableProperty<S>`	`getVersionProperty()` + Returns the designated version property, or null if none. +
`boolean`	`isSupported()` + Returns false only if storable type is `independent` + and no matching table was found. +

+ + +
Methods inherited from interface com.amazon.carbonado.info.StorableInfo
+getAlias, getAliasCount, getAliases, getAlternateKey, getAlternateKeyCount, getAlternateKeys, getIndex, getIndexCount, getIndexes, getName, getPartitionKey, getPrimaryKey, getStorableType, isAuthoritative, isIndependent

+ +
- + + +
  Method Detail
  + + + +
  - +
    isSupported
    +
```
boolean isSupported()
```
    +
    Returns false only if storable type is independent + and no matching table was found.
    +
  + + + +
  - +
    getCatalogName
    +
```
java.lang.String getCatalogName()
```
    +
    Returns the optional catalog name for the Storable. Some databases use a + catalog name to fully qualify the table name.
    +
  + + + +
  - +
    getSchemaName
    +
```
java.lang.String getSchemaName()
```
    +
    Returns the optional schema name for the Storable. Some databases use a + schema name to fully qualify the table name.
    +
  + + + +
  - +
    getTableName
    +
```
java.lang.String getTableName()
```
    +
    Returns the table name for the Storable or null if unsupported.
    +
  + + + +
  - +
    getQualifiedTableName
    +
```
java.lang.String getQualifiedTableName()
```
    +
    Returns the qualified table name for the Storable or null if + unsupported. Is used by SQL statements.
    +
  + + + +
  - +
    getIndexInfo
    +
```
IndexInfo[] getIndexInfo()
```
    +
  + + + +
  - +
    getAllProperties
    +
```
java.util.Map<java.lang.String,JDBCStorableProperty<S>> getAllProperties()
```
    +
    Description copied from interface: StorableInfo
    +
    Returns all the storable properties in an unmodifiable map. Properties + are always ordered, case-sensitive, by name. Primary key properties are + grouped first.
    +
    +
    Specified by:
    +
    getAllProperties in interface StorableInfo<S extends Storable>
    +
    Returns:
    maps property names to property objects
    +
  + + + +
  - +
    getPrimaryKeyProperties
    +
```
java.util.Map<java.lang.String,JDBCStorableProperty<S>> getPrimaryKeyProperties()
```
    +
    Description copied from interface: StorableInfo
    +
    Returns a subset of the storable properties in an unmodifiable map + that define the primary key. Properties are always ordered, + case-sensitive, by name.
    +
    +
    Specified by:
    +
    getPrimaryKeyProperties in interface StorableInfo<S extends Storable>
    +
    Returns:
    maps property names to property objects
    +
  + + + +
  - +
    getDataProperties
    +
```
java.util.Map<java.lang.String,JDBCStorableProperty<S>> getDataProperties()
```
    +
    Description copied from interface: StorableInfo
    +
    Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties. Primary keys and joins are + excluded. Properties are always ordered, case-sensitive, by name.
    +
    +
    Specified by:
    +
    getDataProperties in interface StorableInfo<S extends Storable>
    +
    Returns:
    maps property names to property objects
    +
  + + + +
  - +
    getIdentityProperties
    +
```
java.util.Map<java.lang.String,JDBCStorableProperty<S>> getIdentityProperties()
```
    +
    Returns auto-increment properties which are primary key members. The map + should almost always be empty or contain one property.
    +
    Since:
    +
    1.2
    +
  + + + +
  - +
    getVersionProperty
    +
```
JDBCStorableProperty<S> getVersionProperty()
```
    +
    Description copied from interface: StorableInfo
    +
    Returns the designated version property, or null if none.
    +
    +
    Specified by:
    +
    getVersionProperty in interface StorableInfo<S extends Storable>
    +
    +
  +
+

Interface JDBCStorableInfo<S extends Storable>

Method Summary

Methods inherited from interface com.amazon.carbonado.info.StorableInfo

Method Detail

isSupported

getCatalogName

getSchemaName

getTableName

getQualifiedTableName

getIndexInfo

getAllProperties

getPrimaryKeyProperties

getDataProperties

getIdentityProperties

getVersionProperty