io.permazen.core

Class SchemaItem

java.lang.Object

io.permazen.core.SchemaItem

Direct Known Subclasses:

CompositeIndex, Field, ObjType

public abstract class SchemaItem
extends Object

Superclass for the ObjType, CompositeIndex, and Field classes which make up a Schema version.

Instances have a storage ID which must be unique across the Schema version. Instances also have a name which must be a valid Java identifier. Instances are also associated with a specific Schema.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_PATTERN The regular expression that all SchemaItem names must match.

Method Summary

Modifier and Type	Method and Description
String	getName() Get the name associated with this instance.
Schema	getSchema() Get the schema version with which this instance is associated.
int	getStorageId() Get the storage ID associated with this instance.
abstract String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NAME_PATTERN

public static final String NAME_PATTERN

The regular expression that all SchemaItem names must match. This pattern is the same as is required for Java identifiers.

See Also:

Constant Field Values

Method Detail

getName

public String getName()

Get the name associated with this instance.

Returns:

name of this object type or field, never null

getStorageId

public int getStorageId()

Get the storage ID associated with this instance.

Returns:

storage ID, always greater than zero

getSchema

public Schema getSchema()

Get the schema version with which this instance is associated.

Returns:

associated schema version

toString

public abstract String toString()

Overrides:

toString in class Object