net.sf.saxon.sxpath.SimpleContainer Maven / Gradle / Ivy
Show all versions of saxon-he Show documentation
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2013 Saxonica Limited.
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
package net.sf.saxon.sxpath;
import net.sf.saxon.Configuration;
import net.sf.saxon.event.LocationProvider;
import net.sf.saxon.expr.Container;
import net.sf.saxon.expr.instruct.Executable;
/**
* A simple container for standalone XPath expressions
*/
public class SimpleContainer implements Container {
private Executable executable;
private String systemId = null;
private int lineNumber = -1;
public SimpleContainer(Executable exec) {
this.executable = exec;
}
/**
* Set location information if available
* @param systemId the system Id
* @param lineNumber the line number
*/
public void setLocation(String systemId, int lineNumber) {
this.systemId = systemId;
this.lineNumber = lineNumber;
}
/**
* Get the Executable (representing a complete stylesheet or query) of which this Container forms part
*
* @return the executable
*/
public Executable getExecutable() {
return executable;
}
/**
* Get the LocationProvider allowing location identifiers to be resolved.
*
* @return the location provider
*/
public LocationProvider getLocationProvider() {
return executable.getLocationMap();
}
/**
* Get the host language (XSLT, XQuery, XPath) used to implement the code in this container
*
* @return typically {@link net.sf.saxon.Configuration#XSLT} or {@link net.sf.saxon.Configuration#XQUERY}
*/
public int getHostLanguage() {
return Configuration.XPATH;
}
/**
* Get the granularity of the container. During successive phases of compilation, growing
* expression trees are rooted in containers of increasing granularity. The granularity
* of the container is used to avoid "repotting" a tree more frequently than is required,
* as this requires a complete traversal of the tree which can take a measurable time.
*
* @return 0 for a temporary container created during parsing; 1 for a container
* that operates at the level of an XPath expression; 2 for a container at the level
* of a global function or template
*/
public int getContainerGranularity() {
return 1;
}
/**
* Return the public identifier for the current document event.
*
* The return value is the public identifier of the document
* entity or of the external parsed entity in which the markup that
* triggered the event appears.
*
* @return A string containing the public identifier, or
* null if none is available.
* @see #getSystemId
*/
public String getPublicId() {
return null;
}
/**
* Return the system identifier for the current document event.
*
* The return value is the system identifier of the document
* entity or of the external parsed entity in which the markup that
* triggered the event appears.
*
* If the system identifier is a URL, the parser must resolve it
* fully before passing it to the application.
*
* @return A string containing the system identifier, or null
* if none is available.
* @see #getPublicId
*/
/*@Nullable*/ public String getSystemId() {
return systemId;
}
/**
* Return the line number where the current document event ends.
*
* Warning: The return value from the method
* is intended only as an approximation for the sake of error
* reporting; it is not intended to provide sufficient information
* to edit the character content of the original XML document.
*
* The return value is an approximation of the line number
* in the document entity or external parsed entity where the
* markup that triggered the event appears.
*
* @return The line number, or -1 if none is available.
* @see #getColumnNumber
*/
public int getLineNumber() {
return lineNumber;
}
/**
* Return the character position where the current document event ends.
*
* Warning: The return value from the method
* is intended only as an approximation for the sake of error
* reporting; it is not intended to provide sufficient information
* to edit the character content of the original XML document.
*
* The return value is an approximation of the column number
* in the document entity or external parsed entity where the
* markup that triggered the event appears.
*
* @return The column number, or -1 if none is available.
* @see #getLineNumber
*/
public int getColumnNumber() {
return -1;
}
}