org.apache.ofbiz.entity.model

Class DynamicViewEntity

java.lang.Object

org.apache.ofbiz.entity.model.DynamicViewEntity

public class DynamicViewEntity
extends Object

This class is used for declaring Dynamic View Entities, to be used and thrown away. A special method exists on the Delegator to accept a DynamicViewEntity instead of an entity-name.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<ModelViewEntity.ModelAliasAll>	aliasAlls List of alias-alls which act as a shortcut for easily pulling over member entity fields
protected List<ModelViewEntity.ModelAlias>	aliases List of aliases with information in addition to what is in the standard field list
protected String	defaultResourceName The default-resource-name of the Entity, used with the getResource call to check for a value in a resource bundle
protected String	entityName The entity-name of the Entity
protected List<String>	groupBy List of fields to group by
protected Map<String,ModelViewEntity.ModelMemberEntity>	memberModelMemberEntities Contains member-entity alias name definitions: key is alias, value is ModelMemberEntity
static String	module
protected String	packageName The package-name of the Entity
protected List<ModelRelation>	relations relations defining relationships between this entity and other entities
protected String	title The title for documentation purposes
protected List<ModelViewEntity.ModelViewLink>	viewLinks List of view links to define how entities are connected (or "joined")

Constructor Summary

Constructors

Constructor and Description
DynamicViewEntity()

Method Summary

Modifier and Type	Method and Description
void	addAlias(String entityAlias, String name)
void	addAlias(String entityAlias, String name, String field, String colAlias, Boolean primKey, Boolean groupBy, String function) Add an alias, full detail.
void	addAlias(String entityAlias, String name, String field, String colAlias, Boolean primKey, Boolean groupBy, String function, ModelViewEntity.ComplexAliasMember complexAliasMember)
void	addAlias(String entityAlias, String name, String field, String colAlias, Boolean primKey, Boolean groupBy, String function, String fieldSet, ModelViewEntity.ComplexAliasMember complexAliasMember)
void	addAliasAll(String entityAlias, String prefix) Deprecated. use addAliasAll(String, String, Collection)
void	addAliasAll(String entityAlias, String prefix, Collection<String> excludes)
void	addAllAliasAllsToList(List<ModelViewEntity.ModelAliasAll> addList)
void	addAllAliasesToList(List<ModelViewEntity.ModelAlias> addList)
void	addAllGroupByFieldsToList(List<String> addList)
void	addAllRelationsToList(List<ModelRelation> addList)
void	addAllViewLinksToList(List<ModelViewEntity.ModelViewLink> addList)
void	addMemberEntity(String entityAlias, String entityName)
void	addRelation(String type, String title, String relEntityName, List<ModelKeyMap> modelKeyMaps)
void	addViewLink(String entityAlias, String relEntityAlias, Boolean relOptional, List<ModelKeyMap> modelKeyMaps)
String	getDefaultResourceName() Getter for property defaultResourceName.
String	getEntityName() Getter for property entityName.
Iterator<Map.Entry<String,ModelViewEntity.ModelMemberEntity>>	getModelMemberEntitiesEntryIter()
String	getOneRealEntityName()
String	getPackageName() Getter for property packageName.
String	getTitle() Getter for property title.
Element	getViewElement(Document doc, String entityName)
String	getViewXml(String entityName)
ModelViewEntity	makeModelViewEntity(Delegator delegator)
void	setDefaultResourceName(String defaultResourceName) Setter for property defaultResourceName.
void	setEntityName(String entityName) Setter for property entityName.
void	setGroupBy(List<String> groupBy)
void	setPackageName(String packageName) Setter for property packageName.
void	setTitle(String title) Setter for property title.

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

entityName

protected String entityName

The entity-name of the Entity

packageName

protected String packageName

The package-name of the Entity

defaultResourceName

protected String defaultResourceName

The default-resource-name of the Entity, used with the getResource call to check for a value in a resource bundle

title

protected String title

The title for documentation purposes

memberModelMemberEntities

protected Map<String,ModelViewEntity.ModelMemberEntity> memberModelMemberEntities

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

aliasAlls

protected List<ModelViewEntity.ModelAliasAll> aliasAlls

List of alias-alls which act as a shortcut for easily pulling over member entity fields

aliases

protected List<ModelViewEntity.ModelAlias> aliases

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

groupBy

protected List<String> groupBy

List of fields to group by

viewLinks

protected List<ModelViewEntity.ModelViewLink> viewLinks

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

relations

protected List<ModelRelation> relations

relations defining relationships between this entity and other entities

Constructor Detail

DynamicViewEntity

public DynamicViewEntity()

Method Detail

makeModelViewEntity

public ModelViewEntity makeModelViewEntity(Delegator delegator)

getViewXml

public String getViewXml(String entityName)
                  throws IOException

Throws:

IOException

getViewElement

public Element getViewElement(Document doc,
                              String entityName)

getOneRealEntityName

public String getOneRealEntityName()

getEntityName

public String getEntityName()

Getter for property entityName.

Returns:

Value of property entityName.

setEntityName

public void setEntityName(String entityName)

Setter for property entityName.

Parameters:

entityName - New value of property entityName.

getPackageName

public String getPackageName()

Getter for property packageName.

Returns:

Value of property packageName.

setPackageName

public void setPackageName(String packageName)

Setter for property packageName.

Parameters:

packageName - New value of property packageName.

getDefaultResourceName

public String getDefaultResourceName()

Getter for property defaultResourceName.

Returns:

Value of property defaultResourceName.

setDefaultResourceName

public void setDefaultResourceName(String defaultResourceName)

Setter for property defaultResourceName.

Parameters:

defaultResourceName - New value of property defaultResourceName.

getTitle

public String getTitle()

Getter for property title.

Returns:

Value of property title.

setTitle

public void setTitle(String title)

Setter for property title.

Parameters:

title - New value of property title.

addMemberEntity

public void addMemberEntity(String entityAlias,
                            String entityName)

getModelMemberEntitiesEntryIter

public Iterator<Map.Entry<String,ModelViewEntity.ModelMemberEntity>> getModelMemberEntitiesEntryIter()

addAliasAll

@Deprecated
public void addAliasAll(String entityAlias,
                                    String prefix)

Deprecated. use addAliasAll(String, String, Collection)

addAliasAll

public void addAliasAll(String entityAlias,
                        String prefix,
                        Collection<String> excludes)

addAllAliasAllsToList

public void addAllAliasAllsToList(List<ModelViewEntity.ModelAliasAll> addList)

addAlias

public void addAlias(String entityAlias,
                     String name)

addAlias

public void addAlias(String entityAlias,
                     String name,
                     String field,
                     String colAlias,
                     Boolean primKey,
                     Boolean groupBy,
                     String function)

Add an alias, full detail. All parameters can be null except entityAlias and name.

addAlias

public void addAlias(String entityAlias,
                     String name,
                     String field,
                     String colAlias,
                     Boolean primKey,
                     Boolean groupBy,
                     String function,
                     ModelViewEntity.ComplexAliasMember complexAliasMember)

addAlias

public void addAlias(String entityAlias,
                     String name,
                     String field,
                     String colAlias,
                     Boolean primKey,
                     Boolean groupBy,
                     String function,
                     String fieldSet,
                     ModelViewEntity.ComplexAliasMember complexAliasMember)

addAllAliasesToList

public void addAllAliasesToList(List<ModelViewEntity.ModelAlias> addList)

addViewLink

public void addViewLink(String entityAlias,
                        String relEntityAlias,
                        Boolean relOptional,
                        List<ModelKeyMap> modelKeyMaps)

addAllViewLinksToList

public void addAllViewLinksToList(List<ModelViewEntity.ModelViewLink> addList)

addRelation

public void addRelation(String type,
                        String title,
                        String relEntityName,
                        List<ModelKeyMap> modelKeyMaps)

addAllRelationsToList

public void addAllRelationsToList(List<ModelRelation> addList)

setGroupBy

public void setGroupBy(List<String> groupBy)

addAllGroupByFieldsToList

public void addAllGroupByFieldsToList(List<String> addList)