org.ofbiz.core.entity.model

Class ModelViewEntity

java.lang.Object

org.ofbiz.core.entity.model.ModelEntity

org.ofbiz.core.entity.model.ModelViewEntity

All Implemented Interfaces:

Comparable<ModelEntity>

public class ModelViewEntity
extends ModelEntity

This class extends ModelEntity and provides additional information appropriate to view entities

Since:

2.0

Version:

$Revision: 1.2 $

Author:

David E. Jones, Peter Moon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelViewEntity.ModelAlias
static class	ModelViewEntity.ModelMemberEntity
static class	ModelViewEntity.ModelViewLink

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ModelViewEntity.ModelAlias>	aliases List of aliases with information in addition to what is in the standard field list
protected List<ModelViewEntity.ModelMemberEntity>	allModelMemberEntities A list of all ModelMemberEntity entries; this is mainly used to preserve the original order of member entities from the XML file
protected List<ModelField>	groupBys A List of the Field objects for the View Entity, one for each GROUP BY field
protected Map<String,ModelEntity>	memberModelEntities Contains member-entity ModelEntities: key is alias, value is ModelEntity; populated with fields
protected Map<String,ModelViewEntity.ModelMemberEntity>	memberModelMemberEntities Contains member-entity alias name definitions: key is alias, value is ModelMemberEntity
static String	module
protected List<ModelViewEntity.ModelViewLink>	viewLinks List of view links to define how entities are connected (or "joined")

Fields inherited from class org.ofbiz.core.entity.model.ModelEntity

author, copyright, dependentOn, description, doLock, entityName, fields, fieldsMap, functionBasedIndexes, indexes, modelReader, neverCache, nopks, packageName, pks, relations, STAMP_FIELD, tableName, title, version

Constructor Summary

Constructors

Constructor and Description
ModelViewEntity(ModelReader reader, Element entityElement, Element docElement, UtilTimer utilTimer, Hashtable<String,String> docElementValues)

Method Summary

Modifier and Type	Method and Description
void	addMemberModelMemberEntity(ModelViewEntity.ModelMemberEntity modelMemberEntity)
void	addViewLink(ModelViewEntity.ModelViewLink viewLink)
ModelViewEntity.ModelAlias	getAlias(int index) List of aliases with information in addition to what is in the standard field list
List<ModelViewEntity.ModelAlias>	getAliasesCopy()
Iterator<ModelViewEntity.ModelAlias>	getAliasesIterator()
int	getAliasesSize()
List<ModelViewEntity.ModelMemberEntity>	getAllModelMemberEntities()
List<ModelField>	getGroupBysCopy()
ModelEntity	getMemberModelEntity(String alias)
Map<String,ModelViewEntity.ModelMemberEntity>	getMemberModelMemberEntities()
ModelViewEntity.ModelMemberEntity	getMemberModelMemberEntity(String alias)
ModelViewEntity.ModelViewLink	getViewLink(int index) List of view links to define how entities are connected (or "joined")
List<ModelViewEntity.ModelViewLink>	getViewLinksCopy()
Iterator<ModelViewEntity.ModelViewLink>	getViewLinksIterator()
int	getViewLinksSize()
void	populateFields(Map<String,ModelEntity> entityCache)
void	removeMemberModelMemberEntity(String alias)

Methods inherited from class org.ofbiz.core.entity.model.ModelEntity

addField, addFunctionBasedIndex, addIndex, addRelation, areFields, classNameString, classNameString, colNameString, colNameString, compareTo, fieldNameString, fieldNameString, fieldsStringList, fieldsStringList, fieldsStringList, fieldTypeNameString, finderQueryString, getAllFieldNames, getAuthor, getCopyright, getDependentOn, getDescription, getDoLock, getEntityName, getField, getField, getFieldNamesFromFieldVector, getFieldsCopy, getFieldsIterator, getFieldsSize, getFunctionBasedIndexesIterator, getIndex, getIndex, getIndexesIterator, getIndexesSize, getModelReader, getNeverCache, getNopk, getNoPkFieldNames, getNopksCopy, getNopksIterator, getNopksSize, getPackageName, getPk, getPkFieldNames, getPksCopy, getPksIterator, getPksSize, getPlainTableName, getRelation, getRelation, getRelationsIterator, getRelationsSize, getTableName, getTableName, getTitle, getVersion, httpArgList, httpArgListFromClass, httpArgListFromClass, httpRelationArgList, isField, lock, nameString, nameString, nonPkNullList, pkNameString, pkNameString, populateBasicInfo, populateFunctionBasedIndexes, populateIndexes, populateRelated, primKeyClassNameString, removeField, removeField, removeIndex, removeRelation, setAuthor, setCopyright, setDependentOn, setDescription, setDoLock, setEntityName, setNeverCache, setPackageName, setTableName, setTitle, setVersion, typeNameString, typeNameStringRelatedAndMain, typeNameStringRelatedNoMapped, updatePkLists

Methods inherited from class java.lang.Object

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

Field Detail

module

public static final String module

memberModelMemberEntities

protected Map<String,ModelViewEntity.ModelMemberEntity> memberModelMemberEntities

Contains member-entity alias name definitions: key is alias, value is ModelMemberEntity

allModelMemberEntities

protected List<ModelViewEntity.ModelMemberEntity> allModelMemberEntities

A list of all ModelMemberEntity entries; this is mainly used to preserve the original order of member entities from the XML file

memberModelEntities

protected Map<String,ModelEntity> memberModelEntities

Contains member-entity ModelEntities: key is alias, value is ModelEntity; populated with fields

aliases

protected List<ModelViewEntity.ModelAlias> aliases

List of aliases with information in addition to what is in the standard field list

viewLinks

protected List<ModelViewEntity.ModelViewLink> viewLinks

List of view links to define how entities are connected (or "joined")

groupBys

protected List<ModelField> groupBys

A List of the Field objects for the View Entity, one for each GROUP BY field

Constructor Detail

ModelViewEntity

public ModelViewEntity(ModelReader reader,
                       Element entityElement,
                       Element docElement,
                       UtilTimer utilTimer,
                       Hashtable<String,String> docElementValues)

Method Detail

getMemberModelMemberEntities

public Map<String,ModelViewEntity.ModelMemberEntity> getMemberModelMemberEntities()

getAllModelMemberEntities

public List<ModelViewEntity.ModelMemberEntity> getAllModelMemberEntities()

getMemberModelMemberEntity

public ModelViewEntity.ModelMemberEntity getMemberModelMemberEntity(String alias)

getMemberModelEntity

public ModelEntity getMemberModelEntity(String alias)

addMemberModelMemberEntity

public void addMemberModelMemberEntity(ModelViewEntity.ModelMemberEntity modelMemberEntity)

removeMemberModelMemberEntity

public void removeMemberModelMemberEntity(String alias)

getAlias

public ModelViewEntity.ModelAlias getAlias(int index)

List of aliases with information in addition to what is in the standard field list

getAliasesSize

public int getAliasesSize()

getAliasesIterator

public Iterator<ModelViewEntity.ModelAlias> getAliasesIterator()

getAliasesCopy

public List<ModelViewEntity.ModelAlias> getAliasesCopy()

getGroupBysCopy

public List<ModelField> getGroupBysCopy()

getViewLink

public ModelViewEntity.ModelViewLink getViewLink(int index)

List of view links to define how entities are connected (or "joined")

getViewLinksSize

public int getViewLinksSize()

getViewLinksIterator

public Iterator<ModelViewEntity.ModelViewLink> getViewLinksIterator()

getViewLinksCopy

public List<ModelViewEntity.ModelViewLink> getViewLinksCopy()

addViewLink

public void addViewLink(ModelViewEntity.ModelViewLink viewLink)

populateFields

public void populateFields(Map<String,ModelEntity> entityCache)