Package org.openxava.component

Class MetaComponent

java.lang.Object

org.openxava.component.MetaComponent

All Implemented Interfaces:

Serializable

public class MetaComponent
extends Object
implements Serializable

All meta info about business concept.

A business component is all software artifacts that have relation with a business concept. For example, all view, tables, classes, models, etc. about concept of Seller is the Seller business component.

Author:

Javier Paniza

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MetaComponent()

Method Summary

Modifier and Type	Method	Description
void	addAggregateMapping(AggregateMapping aggregateMapping)
void	addMetaAggregate(MetaAggregate metaAggregate)
void	addMetaTab(MetaTab metaTab)
void	addMetaView(MetaView metaView)
static boolean	exists(String name)
static MetaComponent	get(String name)
AggregateMapping	getAggregateMapping(String name)
Collection	getAggregateMappings()
static Collection<MetaComponent>	getAll()
static Collection<MetaComponent>	getAllLoaded()
static Set	getAllPackageNames()	The names of all the root Java packages used by the components of all OpenXava application in the classpath.
EntityMapping	getEntityMapping()
MetaAggregate	getMetaAggregate(String name)
Collection	getMetaAggregates()
Collection	getMetaAggregatesBeanGenerated()
Collection	getMetaAggregatesForCollectionPojoGenerated()
MetaEntity	getMetaEntity()
MetaTab	getMetaTab()	MetaTab by default.
MetaTab	getMetaTab(String name)	MetaTab from name.
Collection	getMetaTabs()
String	getName()
String	getPackageName()	Java package where the model classes resides.
String	getPackageNameWithSlashWithoutModel()	Package using / instead of . and it does not includes the model package.
IPersistenceProvider	getPersistenceProvider()
static String	getQualifiedPackageForUnqualifiedPackage(String unqualifiedPackage)
boolean	hasMetaAggregate(String name)
boolean	isLabelForModule()
boolean	isMetaDataCached()
boolean	isParsed()	Indicates that this component has been fully parsed.
boolean	isTransient()
void	setEntityMapping(EntityMapping mapping)
void	setLabelForModule(boolean labelForModule)
void	setMetaDataCached(boolean metaDataCached)
void	setMetaEntity(MetaEntity metaEntity)
void	setName(String name)
void	setPackageName(String packageName)
void	setParsed(boolean parsed)
void	setPersistenceProvider(IPersistenceProvider persistenceProvider)
void	setTransient(boolean _transient)

Methods inherited from class java.lang.Object

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

Constructor Details

MetaComponent

public MetaComponent()

Method Details

get

public static MetaComponent get(String name)
                         throws ElementNotFoundException,
XavaException

Throws:

ElementNotFoundException - If component does not exist.

XavaException - Any other problem.

exists

public static boolean exists(String name)
                      throws XavaException

Throws:

XavaException

getAllLoaded

public static Collection<MetaComponent> getAllLoaded()

getName

public String getName()

Returns:

Not null and not empty string

setName

public void setName(String name)

getMetaEntity

public MetaEntity getMetaEntity()

Returns:

Not null.

setMetaEntity

public void setMetaEntity(MetaEntity metaEntity)
                   throws XavaException

Parameters:

metaEntity - Not null

Throws:

XavaException

addMetaView

public void addMetaView(MetaView metaView)
                 throws XavaException

Parameters:

metaView - Not null.

Throws:

XavaException

getMetaAggregate

public MetaAggregate getMetaAggregate(String name)
                               throws XavaException

Returns:

Not null.

Throws:

ElementNotFoundException - If the MetaAggregate does not exist in this component.

XavaException - Any other problem.

hasMetaAggregate

public boolean hasMetaAggregate(String name)

getAggregateMapping

public AggregateMapping getAggregateMapping(String name)
                                     throws XavaException

Returns:

Not null

Throws:

ElementNotFoundException - If does not exist the aggregate mapping in this component.

XavaException - Any other problem.

getAggregateMappings

public Collection getAggregateMappings()
                                throws XavaException

Throws:

XavaException

getMetaAggregates

public Collection getMetaAggregates()
                             throws XavaException

Returns:

Elementss instanceof MetaAggregate. Not null.

Throws:

XavaException - Any other problem.

getMetaAggregatesBeanGenerated

public Collection getMetaAggregatesBeanGenerated()
                                          throws XavaException

Returns:

Elements instanceof MetaAggregateBean and generate == true. Not null.

Throws:

XavaException - Any other problem.

getMetaAggregatesForCollectionPojoGenerated

public Collection getMetaAggregatesForCollectionPojoGenerated()
                                                       throws XavaException

Returns:

Elements instanceof MetaAggregateForCollection and pojoGenerated == true. Not null.

Throws:

XavaException - Any problem.

addMetaAggregate

public void addMetaAggregate(MetaAggregate metaAggregate)

Parameters:

metaAggregate - Not null.

addAggregateMapping

public void addAggregateMapping(AggregateMapping aggregateMapping)
                         throws XavaException

Throws:

XavaException

getMetaTab

public MetaTab getMetaTab()
                   throws XavaException

MetaTab by default.

Returns:

Not null.

Throws:

XavaException

getMetaTabs

public Collection getMetaTabs()

getMetaTab

public MetaTab getMetaTab(String name)
                   throws XavaException,
ElementNotFoundException

MetaTab from name.

Parameters:

name - If null or empty string return default tab.

Returns:

Not null

Throws:

XavaException

ElementNotFoundException

addMetaTab

public void addMetaTab(MetaTab metaTab)
                throws XavaException

Throws:

XavaException

getEntityMapping

public EntityMapping getEntityMapping()
                               throws XavaException

Returns:

Not null.

Throws:

XavaException - Any problem, including that mapping for this component does not exist.

setEntityMapping

public void setEntityMapping(EntityMapping mapping)
                      throws XavaException

Throws:

XavaException

getPackageName

public String getPackageName()
                      throws XavaException

Java package where the model classes resides.

Throws:

XavaException

setPackageName

public void setPackageName(String packageName)

getAllPackageNames

public static Set getAllPackageNames()
                              throws XavaException

The names of all the root Java packages used by the components of all OpenXava application in the classpath.

It's the root package for each application, that it returns com.gestion400.invoicing and not com.gestion400.invoicing.model.

Returns:

Of String

Throws:

XavaException

getQualifiedPackageForUnqualifiedPackage

public static String getQualifiedPackageForUnqualifiedPackage(String unqualifiedPackage)
                                                       throws XavaException

Parameters:

unqualifiedPackage - For example, of org.openxava.test is test, that is to say, without domain (org.openxava).

Throws:

XavaException

getPackageNameWithSlashWithoutModel

public String getPackageNameWithSlashWithoutModel()
                                           throws XavaException

Package using / instead of . and it does not includes the model package.

Throws:

XavaException

getAll

public static Collection<MetaComponent> getAll()
                                        throws XavaException

Throws:

XavaException

isTransient

public boolean isTransient()

setTransient

public void setTransient(boolean _transient)

getPersistenceProvider

public IPersistenceProvider getPersistenceProvider()

setPersistenceProvider

public void setPersistenceProvider(IPersistenceProvider persistenceProvider)

isMetaDataCached

public boolean isMetaDataCached()

setMetaDataCached

public void setMetaDataCached(boolean metaDataCached)

isParsed

public boolean isParsed()

Indicates that this component has been fully parsed.

Used to avoid caching partially parsed components during reentrant parses.

Since:

7.7.2

setParsed

public void setParsed(boolean parsed)

Since:

7.7.2

isLabelForModule

public boolean isLabelForModule()

setLabelForModule

public void setLabelForModule(boolean labelForModule)