net.sf.jso.schema
Class StorableClassMetadata

java.lang.Object
  net.sf.jso.schema.StorableClassMetadata

All Implemented Interfaces:

java.io.Serializable

public class StorableClassMetadata

extends java.lang.Object

implements java.io.Serializable

Class for storable classes's storage management metadata. Storable classes may implement a static method jsoClassMetadata(), with no parameters, that returns an instance of this class. The fields of the returned instance contain additional information for class storage in schema and object storage in database.

See Also:

Serialized Form

Field Summary

java.lang.String[]	accessibleFields Array containing names of the fields that may be accessed throug queries.
boolean	garbageCollectable Indicates if the objects of the class will suffer garbage collection.
StorableIndex[]	indices Array containing indices for the class.
java.lang.String[]	summaryFields Array containing names of the fields that form class' summary.

Constructor Summary

StorableClassMetadata(boolean isCollectable)
Constructs metadata.

StorableClassMetadata(boolean isCollectable, java.lang.String[] aSummary, StorableIndex[] someIndices)
Constructs metadata.

StorableClassMetadata(boolean isCollectable, java.lang.String[] aSummary, java.lang.String[] someAccessible, StorableIndex[] someIndices)
Constructs metadata.

StorableClassMetadata(StorableIndex[] someIndices)
Constructs metadata.

StorableClassMetadata(java.lang.String[] aSummary)
Constructs metadata.

StorableClassMetadata(java.lang.String[] aSummary, StorableIndex[] someIndices)
Constructs metadata.

StorableClassMetadata(java.lang.String[] aSummary, java.lang.String[] someAccessible)
Constructs metadata.

StorableClassMetadata(java.lang.String[] aSummary, java.lang.String[] someAccessible, StorableIndex[] someIndices)
Constructs metadata.

Methods inherited from class java.lang.Object

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

Field Detail

garbageCollectable

public boolean garbageCollectable

Indicates if the objects of the class will suffer garbage collection. If no metadata is informed classes are assumed not to be garbage collectable.

summaryFields

public java.lang.String[] summaryFields

Array containing names of the fields that form class' summary. If no metadata is informed or this field is null or empty all class' fields are assumed to be part of summary.

accessibleFields

public java.lang.String[] accessibleFields

Array containing names of the fields that may be accessed throug queries. If no metadata is informed or this field is null or empty only public fields or fields with getter methods are considered accessible.

indices

public StorableIndex[] indices

Array containing indices for the class. Applications may build indices to accelerate query performance or apply unique constraints on a field or set of fields.

Constructor Detail

StorableClassMetadata

public StorableClassMetadata(boolean isCollectable)

Constructs metadata.

Parameters:

isCollectable - Indicates if the objects of the class will suffer garbage collection.

See Also:

garbageCollectable

StorableClassMetadata

public StorableClassMetadata(java.lang.String[] aSummary)

Constructs metadata.

Parameters:

aSummary - Array containing names of the fields that form class' summary.

See Also:

summaryFields

StorableClassMetadata

public StorableClassMetadata(StorableIndex[] someIndices)

Constructs metadata.

Parameters:

someIndices - Array containing indices for the class.

See Also:

indices

StorableClassMetadata

public StorableClassMetadata(java.lang.String[] aSummary,
                             java.lang.String[] someAccessible)

Constructs metadata.

Parameters:

aSummary - Array containing names of the fields that form class' summary.

someAccessible - Array containing names of the fields that may be accessed throug queries.

See Also:

summaryFields, accessibleFields

StorableClassMetadata

public StorableClassMetadata(java.lang.String[] aSummary,
                             StorableIndex[] someIndices)

Constructs metadata.

Parameters:

aSummary - Array containing names of the fields that form class' summary.

someIndices - Array containing indices for the class.

See Also:

summaryFields, indices

StorableClassMetadata

public StorableClassMetadata(java.lang.String[] aSummary,
                             java.lang.String[] someAccessible,
                             StorableIndex[] someIndices)

Constructs metadata.

Parameters:

aSummary - Array containing names of the fields that form class' summary.

someAccessible - Array containing names of the fields that may be accessed throug queries.

someIndices - Array containing indices for the class.

See Also:

summaryFields, accessibleFields, indices

StorableClassMetadata

public StorableClassMetadata(boolean isCollectable,
                             java.lang.String[] aSummary,
                             StorableIndex[] someIndices)

Constructs metadata.

Parameters:

isCollectable - Indicates if the objects of the class will suffer garbage collection.

aSummary - Array containing names of the fields that form class' summary.

someIndices - Array containing indices for the class.

See Also:

garbageCollectable, summaryFields, indices

StorableClassMetadata

public StorableClassMetadata(boolean isCollectable,
                             java.lang.String[] aSummary,
                             java.lang.String[] someAccessible,
                             StorableIndex[] someIndices)

Constructs metadata.

Parameters:

isCollectable - Indicates if the objects of the class will suffer garbage collection.

aSummary - Array containing names of the fields that form class' summary.

someAccessible - Array containing names of the fields that may be accessed throug queries.

someIndices - Array containing indices for the class.

See Also:

garbageCollectable, summaryFields, accessibleFields, indices