|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gcube.contentmanagement.gcubedocumentlibrary.io.BaseReader
org.gcube.contentmanagement.gcubedocumentlibrary.io.DocumentReader
public class DocumentReader
A Reader
that allows arbitrary Projection
s over document descriptions.
Constructor Summary | |
---|---|
DocumentReader(CollectionReference reference,
GCUBEScope scope)
Creates an instance for a target collection, in a given GCUBEScope . |
|
DocumentReader(CollectionReference reference,
GCUBEScope scope,
GCUBESecurityManager securityManager)
Creates an instance for a target collection, in a given GCUBEScope and with a given GCUBESecurityManager . |
|
DocumentReader(java.lang.String collectionId,
org.apache.axis.message.addressing.EndpointReferenceType endpointReferenceType,
GCUBEScope scope)
Creates an instance for a target collection, in a given GCUBEScope . |
|
DocumentReader(java.lang.String collectionId,
org.apache.axis.message.addressing.EndpointReferenceType endpointReferenceType,
GCUBEScope scope,
GCUBESecurityManager securityManager)
Creates an instance for a target collection, in a given GCUBEScope and with a given GCUBESecurityManager . |
|
DocumentReader(java.lang.String collID,
GCUBEScope scope)
Creates an instance for a target collection in a given GCUBEScope . |
|
DocumentReader(java.lang.String collID,
GCUBEScope scope,
GCUBESecurityManager securityManager)
Creates an instance for a target collection, in a given GCUBEScope and with a given GCUBESecurityManager . |
Method Summary | ||
---|---|---|
java.lang.String |
collectionID()
Returns the identifier of the target collection. |
|
|
get(java.util.Iterator<java.lang.String> ids,
Projection<?,?> p)
Retrieves a stream of proxies of document descriptions in the target collections. |
|
|
get(Projection<?,?> p)
Retrieves a stream of proxies of document descriptions in the target collection. |
|
GCubeDocument |
get(java.lang.String id,
Projection<?,?> p)
Returns a proxy of a document description in the target collection. |
|
|
resolve(java.util.Iterator<java.net.URI> uris,
Projection<E,?> p)
Retrieves a stream of proxies of elements of document descriptions in the target collection. |
|
|
resolve(java.net.URI uri,
Projection<E,?> p)
Retrieves a proxy of an element of a document description in the target collection. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DocumentReader(java.lang.String collID, GCUBEScope scope) throws java.lang.Exception
GCUBEScope
.
collID
- the identifier of the target collection.scope
- the scope.
java.lang.Exception
- id the instance could not be initialised.public DocumentReader(java.lang.String collID, GCUBEScope scope, GCUBESecurityManager securityManager) throws java.lang.Exception
GCUBEScope
and with a given GCUBESecurityManager
.
collID
- the identifier of the target collection.scope
- the scope.securityManager
- the security manager.
java.lang.Exception
- id the instance could not be initialised.public DocumentReader(java.lang.String collectionId, org.apache.axis.message.addressing.EndpointReferenceType endpointReferenceType, GCUBEScope scope) throws java.lang.Exception
GCUBEScope
.
collectionId
- the identifier of the target collection.endpointReferenceType
- the service EPR.scope
- the scope.
java.lang.Exception
- id the instance could not be initialised.public DocumentReader(java.lang.String collectionId, org.apache.axis.message.addressing.EndpointReferenceType endpointReferenceType, GCUBEScope scope, GCUBESecurityManager securityManager) throws java.lang.Exception
GCUBEScope
and with a given GCUBESecurityManager
.
collectionId
- the identifier of the target collection.endpointReferenceType
- the service EPR.scope
- the scope.securityManager
- the security manager.
java.lang.Exception
- id the instance could not be initialised.public DocumentReader(CollectionReference reference, GCUBEScope scope) throws java.lang.Exception
GCUBEScope
.
reference
- a CollectionReference
to the collection.scope
- the scope.
java.lang.Exception
- id the instance could not be initialised.public DocumentReader(CollectionReference reference, GCUBEScope scope, GCUBESecurityManager securityManager) throws java.lang.Exception
GCUBEScope
and with a given GCUBESecurityManager
.
reference
- a CollectionReference
to the collection.scope
- the scope.securityManager
- the security manager.
java.lang.Exception
- id the instance could not be initialised.Method Detail |
---|
public java.lang.String collectionID()
public GCubeDocument get(java.lang.String id, Projection<?,?> p) throws UnknownDocumentException, DiscoveryException, GCUBEException, java.lang.Exception
id
- the identifier of the description.p
- a projection over the inner elements of the description.
UnknownDocumentException
- if a description with the given identifier and matching the given projection is unknown in the target collection.
DiscoveryException
- if the operation could not be completed due to collection 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.publicget(java.util.Iterator<java.lang.String> ids, Projection<?,?> p) throws DiscoveryException, GCUBEException, java.lang.Exception
ids
- an Iterator
over the identifiers of the descriptions.p
- a projection over the inner elements of the descriptions.
RemoteIterator
over the description proxies.
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.publicget(Projection<?,?> p) throws DiscoveryException, GCUBEException, java.lang.Exception
p
- a projection over the inner elements of the descriptions.
RemoteIterator
over the proxies of the descriptions.
DiscoveryException
- if the operation could not be completed due to collection 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.public <E extends GCubeInnerElement> E resolve(java.net.URI uri, Projection<E,?> p) throws java.lang.IllegalArgumentException, UnknownDocumentException, DiscoveryException, GCUBEException, java.lang.Exception
E
- the type of the element.uri
- the content URI of the element.p
- a projection over the element.
java.lang.IllegalArgumentException
- if the URI is not a content URI, or if it does not refers to a description in the target collection.
UnknownDocumentException
- if the URI does not identify an element that matches the given projection.
DiscoveryException
- if the operation could not be completed due to collection 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.public <E extends GCubeInnerElement>resolve(java.util.Iterator<java.net.URI> uris, Projection<E,?> p) throws DiscoveryException, GCUBEException, java.lang.Exception
E
- the type of the elements.uris
- an Iterator
over the content URIs of the elements.p
- the projection over the elements.
RemoteIterator
over the proxies of the elements.
DiscoveryException
- if the operation could not be completed due to collection 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 |