Package net.sf.saxon.lib
Interface CollectionFinder
-
- All Known Implementing Classes:
StandardCollectionFinder
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface CollectionFinderAn instance of CollectionFinder can be registered with the Saxon configuration; it is called in response to calls on the fn:collection() and fn:uri-collection() functions. When these functions are called, thefindCollection(XPathContext, String)method is called to get aResourceCollectionobject representing the collection of resources identified by the supplied collection URI.- Since:
- 9.7: Supersedes URICollectionResolver. The interface was changed to return Resource objects, to allow streamed processing of the documents in a collection; and to pass a properties object that can be used to indicate whether the collection is stable (that is, repeated requests return the same result)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ResourceCollectionfindCollection(XPathContext context, java.lang.String collectionURI)Locate the collection of resources corresponding to a collection URI.
-
-
-
Method Detail
-
findCollection
ResourceCollection findCollection(XPathContext context, java.lang.String collectionURI) throws XPathException
Locate the collection of resources corresponding to a collection URI.- Parameters:
context- The XPath dynamic evaluation contextcollectionURI- The collection URI: an absolute URI, formed by resolving the argument supplied to the fn:collection or fn:uri-collection against the static base URI- Returns:
- a ResourceCollection object representing the resources in the collection identified by this collection URI. Result should not be null.
- Throws:
XPathException- if the collection was not found
-
-