io.permazen.core

Class ObjType

java.lang.Object

io.permazen.core.SchemaItem

io.permazen.core.ObjType

public class ObjType
extends SchemaItem

Represents a Database object type.

Field Summary

Fields inherited from class io.permazen.core.SchemaItem

NAME_PATTERN

Method Summary

Modifier and Type	Method and Description
CompositeIndex	getCompositeIndex(int storageId) Get the CompositeIndex associated with this instance with the given storage ID.
SortedMap<Integer,CompositeIndex>	getCompositeIndexes() Get all composite indexes associated with this object type keyed by storage ID.
SortedMap<String,CompositeIndex>	getCompositeIndexesByName() Get all composite indexes associated with this object type keyed by name.
Field<?>	getField(int storageId) Get the Field in this instance with the given storage ID.
Field<?>	getField(int storageId, boolean searchSubFields) Get the Field in this instance with the given storage ID, optionally searching sub-fields.
SortedMap<Integer,Field<?>>	getFields() Get all fields associated with this object type keyed by storage ID.
SortedMap<String,Field<?>>	getFieldsByName() Get all fields associated with this object type keyed by name.
String	toString()

Methods inherited from class io.permazen.core.SchemaItem

getName, getSchema, getStorageId

Methods inherited from class java.lang.Object

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

Method Detail

getFields

public SortedMap<Integer,Field<?>> getFields()

Get all fields associated with this object type keyed by storage ID. Does not include sub-fields of complex fields.

Returns:

unmodifiable mapping from field storage ID to field

getField

public Field<?> getField(int storageId)

Get the Field in this instance with the given storage ID.

This version does not find sub-fields of ComplexFields; use getField(int, boolean) for that.

Parameters:

storageId - storage ID

Returns:

the Field with storage ID storageID

Throws:

UnknownFieldException - if no top-level Field with storage ID storageId exists

See Also:

getField(int, boolean)

getField

public Field<?> getField(int storageId,
                         boolean searchSubFields)

Get the Field in this instance with the given storage ID, optionally searching sub-fields.

Parameters:

storageId - storage ID

searchSubFields - whether to search in sub-fields as well

Returns:

the Field with storage ID storageID

Throws:

UnknownFieldException - if no Field with storage ID storageId exists

getFieldsByName

public SortedMap<String,Field<?>> getFieldsByName()

Get all fields associated with this object type keyed by name. Does not include sub-fields of complex fields.

Returns:

unmodifiable mapping from field name to field

getCompositeIndexes

public SortedMap<Integer,CompositeIndex> getCompositeIndexes()

Get all composite indexes associated with this object type keyed by storage ID.

Returns:

unmodifiable mapping from composite index storage ID to field

getCompositeIndex

public CompositeIndex getCompositeIndex(int storageId)

Get the CompositeIndex associated with this instance with the given storage ID.

Parameters:

storageId - storage ID

Returns:

the CompositeIndex with storage ID storageID

Throws:

UnknownIndexException - if no CompositeIndex with storage ID storageId exists

getCompositeIndexesByName

public SortedMap<String,CompositeIndex> getCompositeIndexesByName()

Get all composite indexes associated with this object type keyed by name.

Returns:

unmodifiable mapping from index name to index

toString

public String toString()

Specified by:

toString in class SchemaItem