com.haulmont.cuba.core.sys

Class AbstractViewRepository

java.lang.Object

com.haulmont.cuba.core.sys.AbstractViewRepository

All Implemented Interfaces:

ViewRepository

Direct Known Subclasses:

TestViewRepositoryClient, ViewRepositoryClientImpl, ViewRepositoryImpl

public class AbstractViewRepository
extends java.lang.Object
implements ViewRepository

Base implementation of the ViewRepository. Contains methods to store View objects and deploy them from XML.

Don't replace this class completely, because the framework uses it directly.

Field Summary

Fields inherited from interface com.haulmont.cuba.core.global.ViewRepository

NAME

Constructor Summary

Constructors

Constructor and Description
AbstractViewRepository()

Method Summary

Modifier and Type	Method and Description
View	deployView(org.dom4j.Element rootElem, org.dom4j.Element viewElem)
void	deployViews(java.io.InputStream xml)
void	deployViews(java.io.Reader xml)
void	deployViews(java.lang.String resourceUrl)
View	findView(MetaClass metaClass, java.lang.String name) Searches for a View for an entity
java.util.List<View>	getAll()
View	getView(java.lang.Class<? extends Entity> entityClass, java.lang.String name) Get View for an entity.
View	getView(MetaClass metaClass, java.lang.String name) Get View for an entity.
java.util.Collection<java.lang.String>	getViewNames(java.lang.Class<? extends Entity> entityClass) Returns names of views defined for the entityClass
java.util.Collection<java.lang.String>	getViewNames(MetaClass metaClass) Returns names of views defined for the metaClass
void	reset()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractViewRepository

public AbstractViewRepository()

Method Detail

reset

public void reset()

getView

public View getView(java.lang.Class<? extends Entity> entityClass,
                    java.lang.String name)

Get View for an entity.

Specified by:

getView in interface ViewRepository

Parameters:

entityClass - entity class

name - view name

Returns:

view instance. Throws ViewNotFoundException if not found.

getView

public View getView(MetaClass metaClass,
                    java.lang.String name)

Get View for an entity.

Specified by:

getView in interface ViewRepository

Parameters:

metaClass - entity class

name - view name

Returns:

view instance. Throws ViewNotFoundException if not found.

findView

@Nullable
public View findView(MetaClass metaClass,
                               @Nullable
                               java.lang.String name)

Searches for a View for an entity

Specified by:

findView in interface ViewRepository

Parameters:

metaClass - entity class

name - view name

Returns:

view instance or null if no view found

getViewNames

public java.util.Collection<java.lang.String> getViewNames(MetaClass metaClass)

Description copied from interface: ViewRepository

Returns names of views defined for the metaClass

Specified by:

getViewNames in interface ViewRepository

Parameters:

metaClass - entity class

Returns:

names of views

getViewNames

public java.util.Collection<java.lang.String> getViewNames(java.lang.Class<? extends Entity> entityClass)

Description copied from interface: ViewRepository

Returns names of views defined for the entityClass

Specified by:

getViewNames in interface ViewRepository

Parameters:

entityClass - entity class

Returns:

names of views

deployViews

public void deployViews(java.lang.String resourceUrl)

deployViews

public void deployViews(java.io.InputStream xml)

deployViews

public void deployViews(java.io.Reader xml)

deployView

public View deployView(org.dom4j.Element rootElem,
                       org.dom4j.Element viewElem)

getAll

public java.util.List<View> getAll()