Package io.permazen

Class PermazenClass<T>

java.lang.Object

io.permazen.PermazenSchemaItem

io.permazen.PermazenClass<T>

Type Parameters:

T - the Java type that represents instances of this database object type

public class PermazenClass<T>
extends PermazenSchemaItem

Represents a specific Permazen object type in a Permazen database.

Method Summary

Modifier and Type	Method	Description
NavigableMap<String,PermazenCompositeIndex>	getCompositeIndexesByName()	Get all PermazenCompositeIndex's defined on this PermazenClass, indexed by name.
<T extends PermazenField> T	getField(String fieldName, Class<T> type)	Get the specified PermazenField in this database object type, cast to the given Java type.
NavigableMap<String,PermazenField>	getFieldsByName()	Get all PermazenField's associated with this instance, indexed by name.
NavigableMap<Integer,PermazenField>	getFieldsByStorageId()	Get all PermazenField's associated with this instance, indexed by storage ID.
ObjType	getSchemaItem()	Get the corresonding core API database instance.
Class<T>	getType()	Get the Java model object type associated with this instance.

Methods inherited from class io.permazen.PermazenSchemaItem

getName, getSchemaId, getStorageId, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getType

public Class<T> getType()

Get the Java model object type associated with this instance.

Returns:

associated Java type

getFieldsByName

public NavigableMap<String,PermazenField> getFieldsByName()

Get all PermazenField's associated with this instance, indexed by name.

The returned map does not include sub-fields of complex fields.

Returns:

read-only mapping from name to PermazenField

getFieldsByStorageId

public NavigableMap<Integer,PermazenField> getFieldsByStorageId()

Get all PermazenField's associated with this instance, indexed by storage ID.

The returned map does not include sub-fields of complex fields.

Returns:

read-only mapping from storage ID to PermazenField

getCompositeIndexesByName

public NavigableMap<String,PermazenCompositeIndex> getCompositeIndexesByName()

Get all PermazenCompositeIndex's defined on this PermazenClass, indexed by name.

Returns:

read-only mapping from name to PermazenCompositeIndex

getField

public <T extends PermazenField> T getField(String fieldName,
 Class<T> type)

Get the specified PermazenField in this database object type, cast to the given Java type.

Type Parameters:

T - expected encoding

Parameters:

fieldName - field name

type - required type

Returns:

corresponding PermazenField in this instance

Throws:

UnknownFieldException - if fieldName is not found

UnknownFieldException - if the field is not an instance of of type

IllegalArgumentException - if either parameter is null

getSchemaItem

public ObjType getSchemaItem()

Description copied from class: PermazenSchemaItem

Get the corresonding core API database instance.

Overrides:

getSchemaItem in class PermazenSchemaItem

Returns:

this instance's correpsonding SchemaItem