|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
E
- the type of GCubeElement
s characterised by the view.P
- the type of the properties of the GCubeElement
s characterised by the view.public interface CollectionView<E extends GCubeElement,P extends Property>
A local proxy of a remote view defined over the document descriptions of a remote collection.
Collection views are document-oriented abstractions over the generic View
proxies
of the View Manager (VM) service.
Most properties of View
proxies carry over directly
to collection views, including:
collectionId()
);
id()
);
"myview"
(cf. name()
);
"all document descriptions such that..."
(cf. description()
);
QName
like {http://...}mytype
(cf. type()
);
lastUpdate()
)
cardinality()
);
properties()
).
Predicate
s used in View
proxies to characterise the document descriptions in the view become Projection
s over
GCubeElement
s, whether entire document descriptions (i.e. GCubeDocument
s) or specific inner elements of such descriptions
(e.g. GCubeMetadata
s).
Collection views can be used for:
#publish(boolean)
);
findSimilar()
).
In this case, the following view properties are all transformed into equality constraints for the query:
view-by-id
, views-for-collection
,
and views-with-properties
. For cross-collection discovery, see Views.find(String, GCUBEScope)
, Views.find(String, GCUBEScope, GCUBESecurityManager)
.
ViewReader
s for retrieving document descriptions in the remote views (cf. reader()
);
isBound()
).
In particular:
Method Summary | |
---|---|
long |
cardinality()
Returns the cardinality of the view. |
java.lang.String |
collectionId()
Returns the identifier of target collection of the view. |
void |
delete()
Delete the view and un-publish it. |
java.lang.String |
description()
Returns the description of the view. |
java.util.List<? extends CollectionView<E,P>> |
findSimilar()
Returns proxies for all the views that share the same properties as the view associated with this proxy. |
java.lang.String |
id()
Returns the identifier of the view. |
View |
inner()
Returns the inner view. |
boolean |
isBound()
Returns true if this proxy is bound. |
java.util.Calendar |
lastUpdate()
Returns the time in which the view was last updated. |
java.lang.String |
name()
Returns the name of the view. |
Projection<E,P> |
projection()
Returns the Projection that defines the view. |
java.util.Map<javax.xml.namespace.QName,ViewProperty> |
properties()
Returns the generic properties of the view. |
void |
publish()
Publishes this proxy as a remote view. |
void |
publishAndBroadcast()
Publishes this proxy as a remote view and broadcasts the publication. |
ViewReader |
reader()
Returns a Reader for retrieving the elements of the view. |
GCUBEScope |
scope()
Returns the scope of the view. |
GCUBESecurityManager |
securityManager()
Returns the SecurityManager to use view discovery and view-based access. |
javax.xml.namespace.QName |
type()
Returns the type of the view. |
Method Detail |
---|
View inner()
java.lang.String collectionId()
java.lang.String id()
javax.xml.namespace.QName type()
java.lang.String name()
java.lang.String description()
java.util.Calendar lastUpdate()
long cardinality()
Projection<E,P> projection()
Projection
that defines the view.
java.util.Map<javax.xml.namespace.QName,ViewProperty> properties()
GCUBEScope scope()
GCUBESecurityManager securityManager()
SecurityManager
to use view discovery and view-based access.
boolean isBound()
true
if this proxy is bound.
true
if this proxy is bound.ViewReader reader() throws java.lang.IllegalStateException, java.lang.Exception
Reader
for retrieving the elements of the view.
Reader
.
java.lang.IllegalStateException
- if the view is unbound.
java.lang.Exception
- if the Reader
could not be instantiated.void publish() throws java.lang.IllegalStateException, GCUBEException, java.lang.Exception
java.lang.IllegalStateException
- if the view is bound.
GCUBEException
- if the operation fails due to remote errors.
java.lang.Exception
- if the operation fails due to local errors.void publishAndBroadcast() throws java.lang.IllegalStateException, GCUBEException, java.lang.Exception
java.lang.IllegalStateException
- if the view is bound.
GCUBEException
- if the operation fails due to remote errors.
java.lang.Exception
- if the operation fails due to local errors.void delete() throws java.lang.IllegalStateException, GCUBEException, java.lang.Exception
java.lang.IllegalStateException
- if the view is unbound.
GCUBEException
- if the operation fails due to remote errors.
java.lang.Exception
- if the operation fails due to local errors.java.util.List<? extends CollectionView<E,P>> findSimilar() throws DiscoveryException, GCUBEException, java.lang.Exception
DiscoveryException
- if the operation could not be completed due to service discovery errors.
GCUBEException
- if the operation could not be completed due to other forms of remote errors.
java.lang.Exception
- if the operation could not be completed due to local errors.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |