StorableInfo (Carbonado 1.2.3 API)

+
+
All Known Subinterfaces:
+
JDBCStorableInfo<S>
+
+
+
+
```
public interface StorableInfo<S extends Storable>
```
+
Contains all the metadata describing a specific Storable type.
+
Author:
+
Brian S O'Neill, Archit Shivaprakash
+
See Also:
StorableIntrospector
+

+ +

Method Summary

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

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAlias(int index)` + Returns a specific alias for the Storable. +
`int`	`getAliasCount()` + Returns the count of aliases for the Storable. +
`java.lang.String[]`	`getAliases()` + Returns a new array with all the alias names in it. +
`java.util.Map<java.lang.String,? extends StorableProperty<S>>`	`getAllProperties()` + Returns all the storable properties in an unmodifiable map. +
`StorableKey<S>`	`getAlternateKey(int index)` + Returns a specific alternate key for the Storable. +
`int`	`getAlternateKeyCount()` + Returns the count of alternate keys for the Storable. +
`StorableKey<S>[]`	`getAlternateKeys()` + Returns a new array with all the alternate keys in it. +
`java.util.Map<java.lang.String,? extends StorableProperty<S>>`	`getDataProperties()` + Returns a subset of the storable properties in an unmodifiable map + that define the basic data properties. +
`StorableIndex<S>`	`getIndex(int index)` + Returns a specific index for the Storable. +
`int`	`getIndexCount()` + Returns the count of indexes defined for the Storable. +
`StorableIndex<S>[]`	`getIndexes()` + Returns a new array with all the indexes in it. +
`java.lang.String`	`getName()` + Returns the name of the Storable described by this StorableInfo, + which is an abbreviated form of the type's class name. +
`StorableKey<S>`	`getPartitionKey()` + Returns the partition key for the Storable, or null if none exists. +
`StorableKey<S>`	`getPrimaryKey()` + Returns the primary key for the Storable, never null. +
`java.util.Map<java.lang.String,? extends StorableProperty<S>>`	`getPrimaryKeyProperties()` + Returns a subset of the storable properties in an unmodifiable map + that define the primary key. +
`java.lang.Class<S>`	`getStorableType()` + Returns the type of Storable described by this StorableInfo. +
`StorableProperty<S>`	`getVersionProperty()` + Returns the designated version property, or null if none. +
`boolean`	`isAuthoritative()`
`boolean`	`isIndependent()`

+ +
- + + +
  Method Detail
  + + + +
  - +
    getName
    +
```
java.lang.String getName()
```
    +
    Returns the name of the Storable described by this StorableInfo, + which is an abbreviated form of the type's class name.
    +
  + + + +
  - +
    getStorableType
    +
```
java.lang.Class<S> getStorableType()
```
    +
    Returns the type of Storable described by this StorableInfo.
    +
  + + + +
  - +
    getAllProperties
    +
```
java.util.Map<java.lang.String,? extends StorableProperty<S>> getAllProperties()
```
    +
    Returns all the storable properties in an unmodifiable map. Properties + are always ordered, case-sensitive, by name. Primary key properties are + grouped first.
    +
    Returns:
    maps property names to property objects
    +
  + + + +
  - +
    getPrimaryKeyProperties
    +
```
java.util.Map<java.lang.String,? extends StorableProperty<S>> getPrimaryKeyProperties()
```
    +
    Returns a subset of the storable properties in an unmodifiable map + that define the primary key. Properties are always ordered, + case-sensitive, by name.
    +
    Returns:
    maps property names to property objects
    +
  + + + +
  - +
    getDataProperties
    +
```
java.util.Map<java.lang.String,? extends StorableProperty<S>> getDataProperties()
```
    +
    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.
    +
    Returns:
    maps property names to property objects
    +
  + + + +
  - +
    getVersionProperty
    +
```
StorableProperty<S> getVersionProperty()
```
    +
    Returns the designated version property, or null if none.
    +
  + + + +
  - +
    getPrimaryKey
    +
```
StorableKey<S> getPrimaryKey()
```
    +
    Returns the primary key for the Storable, never null.
    +
  + + + +
  - +
    getAlternateKeyCount
    +
```
int getAlternateKeyCount()
```
    +
    Returns the count of alternate keys for the Storable.
    +
  + + + +
  - +
    getAlternateKey
    +
```
StorableKey<S> getAlternateKey(int index)
```
    +
    Returns a specific alternate key for the Storable.
    +
  + + + +
  - +
    getAlternateKeys
    +
```
StorableKey<S>[] getAlternateKeys()
```
    +
    Returns a new array with all the alternate keys in it.
    +
  + + + +
  - +
    getPartitionKey
    +
```
StorableKey<S> getPartitionKey()
```
    +
    Returns the partition key for the Storable, or null if none exists.
    +
  + + + +
  - +
    getAliasCount
    +
```
int getAliasCount()
```
    +
    Returns the count of aliases for the Storable.
    +
  + + + +
  - +
    getAlias
    +
```
java.lang.String getAlias(int index)
+                          throws java.lang.IndexOutOfBoundsException
```
    +
    Returns a specific alias for the Storable.
    +
    Throws:
    +
    java.lang.IndexOutOfBoundsException
    +
  + + + +
  - +
    getAliases
    +
```
java.lang.String[] getAliases()
```
    +
    Returns a new array with all the alias names in it.
    +
  + + + +
  - +
    getIndexCount
    +
```
int getIndexCount()
```
    +
    Returns the count of indexes defined for the Storable.
    +
  + + + +
  - +
    getIndex
    +
```
StorableIndex<S> getIndex(int index)
+                                           throws java.lang.IndexOutOfBoundsException
```
    +
    Returns a specific index for the Storable.
    +
    Throws:
    +
    java.lang.IndexOutOfBoundsException
    +
  + + + +
  - +
    getIndexes
    +
```
StorableIndex<S>[] getIndexes()
```
    +
    Returns a new array with all the indexes in it.
    +
  + + + +
  - +
    isIndependent
    +
```
boolean isIndependent()
```
    +
    See Also:
    Independent
    +
  + + + +
  - +
    isAuthoritative
    +
```
boolean isAuthoritative()
```
    +
    See Also:
    Authoritative
    +
  +
+

Interface StorableInfo<S extends Storable>

Method Summary

Method Detail

getName

getStorableType

getAllProperties

getPrimaryKeyProperties

getDataProperties

getVersionProperty

getPrimaryKey

getAlternateKeyCount

getAlternateKey

getAlternateKeys

getPartitionKey

getAliasCount

getAlias

getAliases

getIndexCount

getIndex

getIndexes

isIndependent

isAuthoritative