Package net.sf.saxon.lib

Interface ResourceCollection

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getCollectionURI()
      Get the URI of the collection
      java.util.Iterator<? extends Resource> getResources​(XPathContext context)
      Get the resources in the collection.
      java.util.Iterator<java.lang.String> getResourceURIs​(XPathContext context)
      Get the URIs of the resources in the collection.
      boolean isStable​(XPathContext context)
      Ask whether the collection is stable: in this case Saxon will retain the contents of the collection in memory, and will not make a second request on the CollectionFinder for the same collection URI.

    • Method Detail

      • getCollectionURI

        java.lang.String getCollectionURI()
        Get the URI of the collection
        Returns:
        The URI as passed to the fn:collection() or fn:uri-collection() function, resolved if it is relative against the static base URI. If the collection() or uri-collection() function was called with no arguments (to get the "default collection") this will be the URI of the default collection registered with the Configuration.

      • getResourceURIs

        java.util.Iterator<java.lang.String> getResourceURIs​(XPathContext context)
                                              throws XPathException
        Get the URIs of the resources in the collection. This supports the fn:uri-collection() function. It is not required that all collections expose a list of URIs in this way, or that the URIs bear any particular relationship to the resources returned by the getResources() method for the same collection URI. The URIs that are returned should be suitable for passing to the registered URIResolver (in the case of XML resources), or the UnparsedTextURIResolver (in the case of unparsed text and JSON resources), etc.
        Parameters:
        context - the XPath evaluation context
        Returns:
        an iterator over the URIs of the resources in the collection. The URIs are represented as Strings. They should preferably be absolute URIs.
        Throws:
        XPathException - in the event of any error (for example, if the collection URI is not recognized)

      • getResources

        java.util.Iterator<? extends Resource> getResources​(XPathContext context)
                                             throws XPathException
        Get the resources in the collection. This supports the fn:collection() function. It is not required that all collections expose a set of resources in this way, or that the resources returned bear any particular relationship to the URIs returned by the getResourceURIs() method for the same collection URI.
        Parameters:
        context - the XPath evaluation context
        Returns:
        an iterator over the resources in the collection. This returns objects of class Resource.
        Throws:
        XPathException - in the event of any error (for example, if the collection URI is not recognized)

      • isStable

        boolean isStable​(XPathContext context)
        Ask whether the collection is stable: in this case Saxon will retain the contents of the collection in memory, and will not make a second request on the CollectionFinder for the same collection URI.
        Parameters:
        context - the XPath dynamic evaluation context (in case the decision is context dependent)