org.neodatis.odb

Interface ClassRepresentation

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DefaultClassRepresentation

public interface ClassRepresentation
extends java.io.Serializable

A class abstraction to give access to class level configuration like adding an index, checking if index exists, rebuilding an index,...

Method Summary

Modifier and Type	Method and Description
void	addFullInstantiationHelper(FullInstantiationHelper instantiationHelper) Adds an helper to tell ODB what class to call to create an instance
void	addIndexOn(java.lang.String name, java.lang.String[] indexFields, boolean verbose)
void	addInstantiationHelper(InstantiationHelper instantiationHelper) Adds an helper to tell ODB what class to call to create an instance
void	addParameterHelper(ParameterHelper parameterHelper) Adds an helper to tell ODB how to create an instance when no default constructor is available
void	addUniqueIndexOn(java.lang.String name, java.lang.String[] indexFields, boolean verbose)
void	deleteIndex(java.lang.String indexName, boolean verbose)
void	doNotPersistAttribute(java.lang.String attributeName)
boolean	existIndex(java.lang.String indexName) To check if an index exist
java.util.List<java.lang.String>	getIndexDescriptions()
void	persistAttribute(java.lang.String attributeName)
void	rebuildIndex(java.lang.String indexName, boolean verbose)
void	removeFullInstantiationHelper() Remove the instantiation helper of this class, if exists
void	removeInstantiationHelper() Remove the instantiation helper of this class, if exists
void	removeParameterHelper() Remove the parameter helper for this class, if exists

Method Detail

addUniqueIndexOn

void addUniqueIndexOn(java.lang.String name,
                      java.lang.String[] indexFields,
                      boolean verbose)

Parameters:

name - The name of the index

indexFields - The list of fields of the index

verbose - A boolean value to indicate of ODB must describe what it is doing

Throws:

java.io.IOException

java.lang.Exception

addIndexOn

void addIndexOn(java.lang.String name,
                java.lang.String[] indexFields,
                boolean verbose)

Parameters:

name - The name of the index

indexFields - The list of fields of the index

verbose - A boolean value to indicate of ODB must describe what it is doing

-

Throws:

java.io.IOException

java.lang.Exception

addParameterHelper

void addParameterHelper(ParameterHelper parameterHelper)

Adds an helper to tell ODB how to create an instance when no default constructor is available

removeParameterHelper

void removeParameterHelper()

Remove the parameter helper for this class, if exists

addInstantiationHelper

void addInstantiationHelper(InstantiationHelper instantiationHelper)

Adds an helper to tell ODB what class to call to create an instance

removeInstantiationHelper

void removeInstantiationHelper()

Remove the instantiation helper of this class, if exists

addFullInstantiationHelper

void addFullInstantiationHelper(FullInstantiationHelper instantiationHelper)

Adds an helper to tell ODB what class to call to create an instance

removeFullInstantiationHelper

void removeFullInstantiationHelper()

Remove the instantiation helper of this class, if exists

existIndex

boolean existIndex(java.lang.String indexName)

To check if an index exist

Parameters:

indexName -

Returns:

rebuildIndex

void rebuildIndex(java.lang.String indexName,
                  boolean verbose)

Parameters:

className -

indexName -

verbose -

deleteIndex

void deleteIndex(java.lang.String indexName,
                 boolean verbose)

Parameters:

className -

indexName -

verbose -

getIndexDescriptions

java.util.List<java.lang.String> getIndexDescriptions()

persistAttribute

void persistAttribute(java.lang.String attributeName)

doNotPersistAttribute

void doNotPersistAttribute(java.lang.String attributeName)