org.qi4j.index.sql.support.skeletons
Interface SQLDBState


public interface SQLDBState

The state-type interface containing some important database-related data, in order to create proper SQL statements in indexing (SQLIndexing), querying ( SQLQuerying) and application startup ( SQLAppStartup.


Method Summary
 Property<java.util.Map<java.lang.String,java.lang.Integer>> entityTypePKs()
           
 Property<java.util.Map<EntityDescriptor,java.util.Set<QualifiedName>>> entityUsedQNames()
          Information about all used qualified names in a certain entity type.
 Property<java.util.Map<java.lang.String,java.lang.Integer>> enumPKs()
           
 Property<java.util.Map<java.lang.Class<?>,java.lang.Integer>> javaTypes2SQLTypes()
          A mapping between java type and the ones in Types.
 Property<java.util.Map<QualifiedName,QNameInfo>> qNameInfos()
          Information about all used qualified names.
 Property<java.lang.String> schemaName()
          The schema name where all the required tables are located.
 Property<java.util.Map<CompositeDescriptor,java.lang.Integer>> usedClassesPKs()
          Primary keys of all used composites in all entities of this application.
 

Method Detail

schemaName

@Optional
Property<java.lang.String> schemaName()
The schema name where all the required tables are located.

Returns:
The schema name where all the required tables are located.

qNameInfos

@Optional
Property<java.util.Map<QualifiedName,QNameInfo>> qNameInfos()
Information about all used qualified names.

Returns:
Information about all used qualified names.
See Also:
QNameInfo

entityUsedQNames

@Optional
Property<java.util.Map<EntityDescriptor,java.util.Set<QualifiedName>>> entityUsedQNames()
Information about all used qualified names in a certain entity type. The interface name of entity type serves as the key.

Returns:
Information about all used qualified names in a certain entity type.

usedClassesPKs

@Optional
Property<java.util.Map<CompositeDescriptor,java.lang.Integer>> usedClassesPKs()
Primary keys of all used composites in all entities of this application. (Value) Composite descriptor is the key.

Returns:
Primary keys of all used classes (of value composites) in all entity types.

entityTypePKs

@Optional
Property<java.util.Map<java.lang.String,java.lang.Integer>> entityTypePKs()

javaTypes2SQLTypes

@Optional
Property<java.util.Map<java.lang.Class<?>,java.lang.Integer>> javaTypes2SQLTypes()
A mapping between java type and the ones in Types. The class of java type is the key.

Returns:
A mapping between java type and the ones in Types.

enumPKs

@Optional
Property<java.util.Map<java.lang.String,java.lang.Integer>> enumPKs()