Package org.ofbiz.core.entity.model

Class ModelReader

java.lang.Object

org.ofbiz.core.entity.model.ModelReader

public class ModelReader
extends Object

Generic Entity - Entity Definition Reader

Since:

2.0

Version:

$Revision: 1.1 $

Author:

David E. Jones, Andy Zeneski

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,ModelEntity>	entityCache
protected Map<String,ResourceHandler>	entityResourceHandlerMap	for each entity contains a map to the ResourceHandler that the entity came from
protected Collection<ResourceHandler>	entityResourceHandlers	collection of filenames for entity definitions
protected String	modelName
static final String	module
protected int	numEntities
protected int	numFields
protected int	numRelations
protected int	numViewEntities
static final UtilCache<String,ModelReader>	readers
protected Map<ResourceHandler,Collection<String>>	resourceHandlerEntities	contains a collection of entity names for each ResourceHandler, populated as they are loaded

Constructor Summary

Constructors

Constructor	Description
ModelReader(String modelName)

Method Summary

Modifier and Type	Method	Description
void	addEntityToResourceHandler(String entityName, String loaderName, String location)
ModelField	createModelField(Element fieldElement, Element docElement, Hashtable<String,String> docElementValues)
ModelRelation	createRelation(ModelEntity entity, Element relationElement)
ModelField	findModelField(ModelEntity entity, String fieldName)
Map<String,ModelEntity>	getEntityCache()
Collection<String>	getEntityNames()	Creates a Collection with the entityName of each Entity defined in the specified XML Entity Descriptor file.
Iterator<String>	getEntityNamesIterator()	Creates a Iterator with the entityName of each Entity defined in the specified XML Entity Descriptor file.
ResourceHandler	getEntityResourceHandler(String entityName)
ModelEntity	getModelEntity(String entityName)	Gets an Entity object based on a definition from the specified XML Entity descriptor file.
static ModelReader	getModelReader(String delegatorName)
Collection<String>	getResourceHandlerEntities(ResourceHandler resourceHandler)
Iterator<ResourceHandler>	getResourceHandlerEntitiesKeyIterator()
void	rebuildResourceHandlerEntities()	rebuilds the resourceHandlerEntities Map of Collections based on the current entityResourceHandlerMap Map, must be done whenever a manual change is made to the entityResourceHandlerMap Map after the initial load to make them consistent again.

Methods inherited from class java.lang.Object

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

Field Details

module

public static final String module

readers

public static final UtilCache<String,ModelReader> readers

entityCache

protected Map<String,ModelEntity> entityCache

numEntities

protected int numEntities

numViewEntities

protected int numViewEntities

numFields

protected int numFields

numRelations

protected int numRelations

modelName

protected String modelName

entityResourceHandlers

protected Collection<ResourceHandler> entityResourceHandlers

collection of filenames for entity definitions

resourceHandlerEntities

protected Map<ResourceHandler,Collection<String>> resourceHandlerEntities

contains a collection of entity names for each ResourceHandler, populated as they are loaded

entityResourceHandlerMap

protected Map<String,ResourceHandler> entityResourceHandlerMap

for each entity contains a map to the ResourceHandler that the entity came from

Constructor Details

ModelReader

public ModelReader(String modelName)
            throws GenericEntityException

Throws:

GenericEntityException

Method Details

getModelReader

public static ModelReader getModelReader(String delegatorName)
                                  throws GenericEntityException

Throws:

GenericEntityException

getEntityCache

public Map<String,ModelEntity> getEntityCache()
                                       throws GenericEntityException

Throws:

GenericEntityException

rebuildResourceHandlerEntities

public void rebuildResourceHandlerEntities()

rebuilds the resourceHandlerEntities Map of Collections based on the current entityResourceHandlerMap Map, must be done whenever a manual change is made to the entityResourceHandlerMap Map after the initial load to make them consistent again.

getResourceHandlerEntitiesKeyIterator

public Iterator<ResourceHandler> getResourceHandlerEntitiesKeyIterator()

getResourceHandlerEntities

public Collection<String> getResourceHandlerEntities(ResourceHandler resourceHandler)

addEntityToResourceHandler

public void addEntityToResourceHandler(String entityName,
 String loaderName,
 String location)

getEntityResourceHandler

public ResourceHandler getEntityResourceHandler(String entityName)

getModelEntity

public ModelEntity getModelEntity(String entityName)
                           throws GenericEntityException

Gets an Entity object based on a definition from the specified XML Entity descriptor file.

Parameters:

entityName - The entityName of the Entity definition to use.

Returns:

An Entity object describing the specified entity of the specified descriptor file.

Throws:

GenericEntityException

getEntityNamesIterator

public Iterator<String> getEntityNamesIterator()
                                        throws GenericEntityException

Creates a Iterator with the entityName of each Entity defined in the specified XML Entity Descriptor file.

Returns:

A Iterator of entityName Strings

Throws:

GenericEntityException

getEntityNames

public Collection<String> getEntityNames()
                                  throws GenericEntityException

Creates a Collection with the entityName of each Entity defined in the specified XML Entity Descriptor file.

Returns:

A Collection of entityName Strings

Throws:

GenericEntityException

createRelation

public ModelRelation createRelation(ModelEntity entity,
 Element relationElement)

findModelField

public ModelField findModelField(ModelEntity entity,
 String fieldName)

createModelField

public ModelField createModelField(Element fieldElement,
 Element docElement,
 Hashtable<String,String> docElementValues)