com.ddtek.xquery
Interface CollectionURIResolver

public interface CollectionURIResolver

An object that implements this interface that can be called by DataDirect XQuery to turn a file collection URI used in a call to fn:collection(), into a set of Source objects.

Method Summary

Iterator

resolve(String href, String base) Called when a fn:collection() function is encountered, that references a file collection.

Method Detail

resolve

public Iterator resolve(String href,
                        String base)
                 throws TransformerException

Called when a fn:collection() function is encountered, that references a file collection.

Parameters:

href - an href attribute, which may be relative or absolute. This argument will be null for a call to the default collection.

base - the base URI against which the first argument will be made absolute if the absolute URI is required; or null if no base URI is known.

Returns:

An Iterator over the documents in the collection. The items returned in this iterator must be supported instances of Source. If null is returned, the system will attempt to resolve the URI using the default collection URI resolver.

Throws:

TransformerException - if an error occurs when trying to resolve the URI.