Package org.apache.olingo.odata2.core.ep.aggregator

Class EntityInfoAggregator

java.lang.Object

org.apache.olingo.odata2.core.ep.aggregator.EntityInfoAggregator

public class EntityInfoAggregator
extends Object

Aggregator to get easy and fast access to all for serialization and de-serialization necessary EdmEntitySet informations.

Method Summary

Modifier and Type	Method	Description
boolean	canEdit()
static Map<String,EntityPropertyInfo>	create(EdmComplexType complexType)	Create an map of complex type property name to EntityPropertyInfo based on given EdmComplexType
static EntityInfoAggregator	create(EdmEntitySet entitySet)	Create an EntityInfoAggregator based on given EdmEntitySet
static EntityInfoAggregator	create(EdmEntitySet entitySet, ExpandSelectTreeNode expandSelectTree)	Create an EntityInfoAggregator based on given EdmEntitySet
static EntityPropertyInfo	create(EdmFunctionImport functionImport)	Create an EntityPropertyInfo based on given EdmFunctionImport
static EntityPropertyInfo	create(EdmProperty property)	Create an EntityPropertyInfo based on given EdmProperty
String	getEntityContainerName()
EdmEntitySet	getEntitySet()
String	getEntitySetName()
EdmEntityType	getEntityType()
Collection<EntityPropertyInfo>	getETagPropertyInfos()
List<String>	getExpandedNavigationPropertyNames()
List<EntityPropertyInfo>	getKeyPropertyInfos()
NavigationPropertyInfo	getNavigationPropertyInfo(String name)
List<String>	getNavigationPropertyNames()
List<String>	getNoneSyndicationTargetPathNames()
EntityPropertyInfo	getPropertyInfo(String name)
Collection<EntityPropertyInfo>	getPropertyInfos()
List<String>	getPropertyNames()
List<String>	getSelectedNavigationPropertyNames()
List<String>	getSelectedPropertyNames()
EntityPropertyInfo	getTargetPathInfo(String targetPath)
Collection<String>	getTargetPathNames()
boolean	isDefaultEntityContainer()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static EntityInfoAggregator create(EdmEntitySet entitySet,
                                          ExpandSelectTreeNode expandSelectTree)
                                   throws EntityProviderException

Create an EntityInfoAggregator based on given EdmEntitySet

Parameters:

entitySet - with which the EntityInfoAggregator is initialized.

expandSelectTree -

Returns:

created and initialized EntityInfoAggregator

Throws:

EntityProviderException - if during initialization of EntityInfoAggregator something goes wrong (e.g. exceptions during access of EdmEntitySet).

canEdit

public boolean canEdit()

create

public static EntityInfoAggregator create(EdmEntitySet entitySet)
                                   throws EntityProviderException

Create an EntityInfoAggregator based on given EdmEntitySet

Parameters:

entitySet - with which the EntityInfoAggregator is initialized.

Returns:

created and initialized EntityInfoAggregator

Throws:

EntityProviderException - if during initialization of EntityInfoAggregator something goes wrong (e.g. exceptions during access of EdmEntitySet).

create

public static EntityPropertyInfo create(EdmProperty property)
                                 throws EntityProviderException

Create an EntityPropertyInfo based on given EdmProperty

Parameters:

property - for which the EntityPropertyInfo is created.

Returns:

created EntityPropertyInfo

Throws:

EntityProviderException - if create of EntityPropertyInfo something goes wrong (e.g. exceptions during access of EdmProperty).

create

public static Map<String,EntityPropertyInfo> create(EdmComplexType complexType)
                                                   throws EntityProviderException

Create an map of complex type property name to EntityPropertyInfo based on given EdmComplexType

Parameters:

complexType - for which the EntityPropertyInfo is created.

Returns:

created map of complex type property name to EntityPropertyInfo

Throws:

EntityProviderException - if create of EntityPropertyInfo something goes wrong (e.g. exceptions during access of EntityPropertyInfo).

create

public static EntityPropertyInfo create(EdmFunctionImport functionImport)
                                 throws EntityProviderException

Create an EntityPropertyInfo based on given EdmFunctionImport

Parameters:

functionImport - for which the EntityPropertyInfo is created.

Returns:

created EntityPropertyInfo

Throws:

EntityProviderException - if create of EntityPropertyInfo something goes wrong (e.g. exceptions during access of EdmFunctionImport).

getEntitySet

public EdmEntitySet getEntitySet()

Returns:

the edm entity set which was used to build this entity info aggregator object

getEntitySetName

public String getEntitySetName()

Returns:

entity set name.

isDefaultEntityContainer

public boolean isDefaultEntityContainer()

Returns:

true if the entity container of EdmEntitySet is the default container, otherwise false.

getTargetPathInfo

public EntityPropertyInfo getTargetPathInfo(String targetPath)

getEntityType

public EdmEntityType getEntityType()

getEntityContainerName

public String getEntityContainerName()

getTargetPathNames

public Collection<String> getTargetPathNames()

Returns:

unmodifiable set of all found target path names.

getNoneSyndicationTargetPathNames

public List<String> getNoneSyndicationTargetPathNames()

Returns:

unmodifiable set of found none syndication target path names (all target path names which are not pre-defined).

getNavigationPropertyNames

public List<String> getNavigationPropertyNames()
                                        throws EntityProviderException

Returns:

unmodifiable set of all found navigation property names.

Throws:

EntityProviderException

getPropertyNames

public List<String> getPropertyNames()
                              throws EntityProviderException

Returns:

unmodifiable set of all property names.

Throws:

EntityProviderException

getSelectedPropertyNames

public List<String> getSelectedPropertyNames()
                                      throws EntityProviderException

Returns:

unmodifiable set of selected property names.

Throws:

EntityProviderException

getSelectedNavigationPropertyNames

public List<String> getSelectedNavigationPropertyNames()
                                                throws EntityProviderException

Returns:

unmodifiable set of selected property names.

Throws:

EntityProviderException

getPropertyInfos

public Collection<EntityPropertyInfo> getPropertyInfos()

getPropertyInfo

public EntityPropertyInfo getPropertyInfo(String name)

getETagPropertyInfos

public Collection<EntityPropertyInfo> getETagPropertyInfos()

getKeyPropertyInfos

public List<EntityPropertyInfo> getKeyPropertyInfos()
                                             throws EntityProviderException

Returns:

list of all key property infos

Throws:

EntityProviderException

getNavigationPropertyInfo

public NavigationPropertyInfo getNavigationPropertyInfo(String name)

getExpandedNavigationPropertyNames

public List<String> getExpandedNavigationPropertyNames()