net.sf.saxon.resource

Class AbstractResourceCollection

java.lang.Object

net.sf.saxon.resource.AbstractResourceCollection

All Implemented Interfaces:

ResourceCollection

Direct Known Subclasses:

CatalogCollection, DirectoryCollection, JarCollection

public abstract class AbstractResourceCollection
extends java.lang.Object
implements ResourceCollection

AbstractCollection is an abstract superclass for the various implementations of ResourceCollection within Saxon. It provides common services such as mapping of file extensions to MIME types, and mapping of MIME types to resource factories.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractResourceCollection.InputDetails

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	collectionURI
protected Configuration	config
protected URIQueryParameters	params

Constructor Summary

Constructors

Constructor and Description
AbstractResourceCollection(Configuration config)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCollectionURI() Get the URI of the collection
protected AbstractResourceCollection.InputDetails	getInputDetails(java.lang.String resourceURI)
protected java.lang.String	guessContentType(java.lang.String resourceURI, java.io.InputStream stream) Guess the content type of a resource from its name and/or its content
boolean	isStable(XPathContext context) Ask whether the collection is stable.
Resource	makeResource(Configuration config, AbstractResourceCollection.InputDetails details, java.lang.String resourceURI) Internal method to make a resource for a single entry in the ZIP or JAR file.
Resource	makeResource(Configuration config, java.lang.String resourceURI) Default method to make a resource, given a resource URI
protected ParseOptions	optionsFromQueryParameters(URIQueryParameters params, XPathContext context)
void	registerContentType(java.lang.String contentType, ResourceFactory factory) Associate a media type with a resource factory.
boolean	stripWhitespace(SpaceStrippingRule rules) Supply information about the whitespace stripping rules that apply to this collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.lib.ResourceCollection

getResources, getResourceURIs

Field Detail

config

protected Configuration config

collectionURI

protected java.lang.String collectionURI

params

protected URIQueryParameters params

Constructor Detail

AbstractResourceCollection

public AbstractResourceCollection(Configuration config)

Method Detail

getCollectionURI

public java.lang.String getCollectionURI()

Description copied from interface: ResourceCollection

Get the URI of the collection

Specified by:

getCollectionURI in interface ResourceCollection

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.

isStable

public boolean isStable(XPathContext context)

Ask whether the collection is stable. This method should only be called after calling ResourceCollection.getResources(XPathContext) or ResourceCollection.getResourceURIs(XPathContext)

Specified by:

isStable in interface ResourceCollection

Parameters:

context - the XPath evaluation context.

Returns:

true if the collection is defined to be stable, that is, if a subsequent call on collection() with the same URI is guaranteed to return the same result. The method returns true if the query parameter stable=yes is present in the URI, or if the configuration property FeatureKeys.STABLE_COLLECTION_URI is set.

registerContentType

public void registerContentType(java.lang.String contentType,
                                ResourceFactory factory)

Associate a media type with a resource factory. Since 9.7.0.6 this registers the content type with the configuration, making the register of content types more accessible to applications.

Parameters:

contentType - a media type or MIME type, for example application/xsd+xml

factory - a ResourceFactory used to parse (or otherwise process) resources of that type

optionsFromQueryParameters

protected ParseOptions optionsFromQueryParameters(URIQueryParameters params,
                                                  XPathContext context)

getInputDetails

protected AbstractResourceCollection.InputDetails getInputDetails(java.lang.String resourceURI)
                                                           throws XPathException

Throws:

XPathException

guessContentType

protected java.lang.String guessContentType(java.lang.String resourceURI,
                                            java.io.InputStream stream)

Guess the content type of a resource from its name and/or its content

Parameters:

resourceURI - the resource URI

stream - the content of the resource. The stream must be positioned at the start. The method looks ahead in this stream but resets the current position on exit.

Returns:

the media type, or null.

makeResource

public Resource makeResource(Configuration config,
                             AbstractResourceCollection.InputDetails details,
                             java.lang.String resourceURI)
                      throws XPathException

Internal method to make a resource for a single entry in the ZIP or JAR file. This involves making decisions about the type of resource. This method can be overridden in a user-defined subclass.

Parameters:

config - The Saxon configuration

details - Details of the input, including the input stream delivering the content of the resource. The method is expected to consume this input stream; the caller will close it on return.

resourceURI - the URI of the entry within the ZIP or JAR file; this will by default be in the form collectionURI!path

Returns:

a newly created Resource representing the content of this entry in the ZIP or JAR file

Throws:

XPathException

makeResource

public Resource makeResource(Configuration config,
                             java.lang.String resourceURI)
                      throws XPathException

Default method to make a resource, given a resource URI

Parameters:

resourceURI - the resource URI

Returns:

the corresponding resource

Throws:

XPathException

stripWhitespace

public boolean stripWhitespace(SpaceStrippingRule rules)

Supply information about the whitespace stripping rules that apply to this collection. This method will only be called when the collection() function is invoked from XSLT.

Specified by:

stripWhitespace in interface ResourceCollection

Parameters:

rules - the space-stripping rules that apply to this collection, derived from the xsl:strip-space and xsl:preserve-space declarations in the stylesheet package containing the call to the collection() function.

Returns:

true if the collection finder intends to take responsibility for whitespace stripping according to these rules; false if it wishes Saxon itself to post-process any returned XML documents to strip whitespace. Returning true may either indicate that the collection finder will strip whitespace before returning a document, or it may indicate that it does not wish the space stripping rules to be applied. The default (returned by this method if not overridden) is false.