Package io.permazen.schema

Class SchemaCompositeIndex

java.lang.Object

io.permazen.util.AbstractXMLStreaming

io.permazen.schema.SchemaItem

io.permazen.schema.SchemaCompositeIndex

All Implemented Interfaces:

DiffGenerating<SchemaCompositeIndex>, Cloneable

public class SchemaCompositeIndex
extends SchemaItem
implements DiffGenerating<SchemaCompositeIndex>

An index on two or more fields in a SchemaObjectType.

Field Summary

Fields

Modifier and Type	Field	Description
static final ItemType	ITEM_TYPE	The ItemType that this class represents.

Fields inherited from class io.permazen.schema.SchemaItem

NAME_PATTERN

Constructor Summary

Constructors

Constructor	Description
SchemaCompositeIndex()

Method Summary

Modifier and Type	Method	Description
SchemaCompositeIndex	clone()	Deep-clone this instance.
Diffs	differencesFrom(SchemaCompositeIndex that)	Detect the differences of this instance when compared to the given instance.
boolean	equals(Object obj)
List<String>	getIndexedFields()	Get the fields that comprise this index.
final ItemType	getItemType()	Get the ItemType corresponding to this instance.
SchemaObjectType	getObjectType()	Get the SchemaObjectType of which this field is a member.
final SchemaId	getSchemaId()	Generate a unique SchemaId corresponding to the type and encoding structure of this schema item.
int	hashCode()
final boolean	isLockedDown(boolean includingStorageIds)	Determine whether this instance is locked down.
final void	setObjectType(SchemaObjectType objectType)	Set the SchemaObjectType of which this field is a member.
String	toString()
final <T extends SchemaItem> void	visitSchemaItems(Class<T> nodeType, Consumer<? super T> visitor)	Visit this schema item and all of its descendents matching the given type with the given visitor.
void	visitSchemaItems(Consumer<? super SchemaItem> visitor)	Visit all SchemaItem descendents of this instance with the given visitor.

Methods inherited from class io.permazen.schema.SchemaItem

differencesFrom, getName, getStorageId, setName, setStorageId

Methods inherited from class io.permazen.util.AbstractXMLStreaming

expect, expectClose, getAttr, getAttr, getBooleanAttr, getBooleanAttr, getIntAttr, getIntAttr, getLongAttr, newInvalidAttributeException, newInvalidInputException, newInvalidInputException, next, skip, writeAttr, writeElement, writeEmptyElement, writeStartElement

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ITEM_TYPE

public static final ItemType ITEM_TYPE

The ItemType that this class represents.

Constructor Details

SchemaCompositeIndex

public SchemaCompositeIndex()

Method Details

getIndexedFields

public List<String> getIndexedFields()

Get the fields that comprise this index.

Returns:

names of indexed fields

getItemType

public final ItemType getItemType()

Get the ItemType corresponding to this instance.

Returns:

schema item type

differencesFrom

public Diffs differencesFrom(SchemaCompositeIndex that)

Description copied from interface: DiffGenerating

Detect the differences of this instance when compared to the given instance.

Specified by:

differencesFrom in interface DiffGenerating<SchemaCompositeIndex>

Parameters:

that - other instance

Returns:

differences; will be empty if there are none detected

toString

public String toString()

Specified by:

toString in class SchemaItem

equals

public boolean equals(Object obj)

Overrides:

equals in class SchemaItem

hashCode

public int hashCode()

Overrides:

hashCode in class SchemaItem

clone

public SchemaCompositeIndex clone()

Deep-clone this instance.

The returned instance will not be locked down even if this one is.

getObjectType

public SchemaObjectType getObjectType()

Get the SchemaObjectType of which this field is a member.

Returns:

containing object type

setObjectType

public final void setObjectType(SchemaObjectType objectType)

Set the SchemaObjectType of which this field is a member.

Note: this field is considered derived information, and will be set automatically when a referrring SchemaObjectType is locked down.

Parameters:

objectType - containing object type

Throws:

UnsupportedOperationException - if this instance is locked down

visitSchemaItems

public void visitSchemaItems(Consumer<? super SchemaItem> visitor)

Visit all SchemaItem descendents of this instance with the given visitor.

If this instance is also a SchemaItem, then also visit this instance.

The traversal is depth first, pre-order.

Parameters:

visitor - visitor for schema items

Throws:

IllegalArgumentException - if visitor is null

visitSchemaItems

public final <T extends SchemaItem> void visitSchemaItems(Class<T> nodeType,
 Consumer<? super T> visitor)

Visit this schema item and all of its descendents matching the given type with the given visitor.

The traversal is depth first, post-order.

Parameters:

nodeType - node type to include

visitor - visitor for schema items

Throws:

IllegalArgumentException - if either parameter is null

isLockedDown

public final boolean isLockedDown(boolean includingStorageIds)

Determine whether this instance is locked down.

Parameters:

includingStorageIds - false to test all but storage ID's, true to require storage ID's to be locked down as well

Returns:

true if instance is locked down, otherwise false

getSchemaId

public final SchemaId getSchemaId()

Generate a unique SchemaId corresponding to the type and encoding structure of this schema item.

The SchemaId does not depend on the storage ID.

This instance must be locked down except for storage ID's. Repeated invocations of this method will be very fast, just returning the cached previous result.

Returns:

schema ID

Throws:

IllegalStateException - if this instance is not locked down

See Also:

• SchemaId