net.sf.saxon.expr.Component Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of Saxon-HE Show documentation
Show all versions of Saxon-HE Show documentation
The XSLT and XQuery Processor
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2015 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.expr;
import net.sf.saxon.expr.instruct.ComponentCode;
import net.sf.saxon.style.StylesheetPackage;
import net.sf.saxon.trace.ExpressionPresenter;
import net.sf.saxon.trans.Visibility;
import net.sf.saxon.trans.XPathException;
import net.sf.saxon.tree.util.FastStringBuffer;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
/**
* Represents a component as defined in the XSLT 3.0 specification: for example a function, a named template,
* an attribute set, a global variable.
*/
public class Component {
private T code;
private Visibility visibility;
private List bindings = new ArrayList();
private StylesheetPackage containingPackage;
private StylesheetPackage declaringPackage;
private boolean hasExplicitVisibility;
private Component baseComponent;
/**
* Create a component
*
* @param code the compiled code that implements the component, for example a Template or Function
* @param visibility the visibility of the component
* @param containingPackage the package to which this component belongs
* @param declaringPackage the package in which the original declaration of the component appears
*/
public Component(T code, Visibility visibility, StylesheetPackage containingPackage, StylesheetPackage declaringPackage) {
this.code = code;
this.visibility = visibility;
this.containingPackage = containingPackage;
this.declaringPackage = declaringPackage;
}
/**
* Get the component's binding vector; that is the list of external references to other components
*
* @return the binding vector, a list of component bindings. These are identified by a binding
* slot number held with the individual instruction (such as a call-template instruction or a global
* variable reference) that contains the external component reference.
*/
public List getComponentBindings() {
return bindings;
}
/**
* Set the component's binding vector; that is the list of external references to other components
*
* @param bindings the binding vector, a list of component bindings. These are identified by a binding
* slot number held with the individual instruction (such as a call-template instruction or a global
* variable reference) that contains the external component reference.
*/
public void setComponentBindings(List bindings) {
this.bindings = bindings;
}
/**
* Set the visibility of the component, and say whether it is explicit or defaulted
* @param visibility the visibility of the component
* @param explicit set to true if the visibility is an explicit attribute on the component declaration
*/
public void setVisibility(Visibility visibility, boolean explicit) {
this.visibility = visibility;
this.hasExplicitVisibility = explicit;
}
/**
* Get the visibility of the component
*
* @return the component's visibility. In the declaring package this will be the original
* declared or exposed visibility; in a using package, it will be the visibility of the component
* within that package.
*/
public Visibility getVisibility() {
return visibility;
}
/**
* Ask whether the visibility of the component is due to an explicit visibility attribute on the component
* declaration
* @return true if the visibility was explicitly declared
*/
public boolean isVisibilityExplicit() {
return hasExplicitVisibility;
}
/**
* Get the code (for example a compiled template, function, or variable) that is executed
* when this component is called
*
* @return the code forming the implementation of this component
*/
public T getCode() {
return code;
}
/**
* Get the declaring package of this component
*
* @return the package in which the code of the component was originally declared
*/
public StylesheetPackage getDeclaringPackage() {
return declaringPackage;
}
/**
* Get the containing package of this component
*
* @return the package that contains this (version of the) component
*/
public StylesheetPackage getContainingPackage() {
return containingPackage;
}
/**
* Get the component from which this one is derived
* @return the component from which this one is derived. This is set when the component appears in the
* package as a result of xsl:use-package; a component C in the used package is modified to create a
* component D in the using package, and D.getBaseComponent() returns C. The value will be null
* in the case of a component whose declaring package is the same as its containing package, that is,
* an "original" component (including an overriding component)
*/
public Component getBaseComponent() {
return baseComponent;
}
/**
* Set the component from which this one is derived
*
* @param original the component from which this one is derived. This is set when the component appears in the
* package as a result of xsl:use-package; a component C in the used package is modified to create a
* component D in the using package, and D.getBaseComponent() returns C. The value will be null
* in the case of a component whose declaring package is the same as its containing package, that is,
* an "original" component (including an overriding component)
*/
public void setBaseComponent(Component original) {
baseComponent = original;
}
public void export(ExpressionPresenter out, Map componentIdMap) throws XPathException {
out.startElement("co");
int id = obtainComponentId(this, componentIdMap);
out.emitAttribute("id", ""+id);
if (getVisibility() != null && getVisibility() != Visibility.PRIVATE) {
out.emitAttribute("vis", getVisibility().toString());
}
String refs = listComponentReferences(componentIdMap).toString();
out.emitAttribute("binds", refs);
if (baseComponent != null) {
int baseId = obtainComponentId(baseComponent, componentIdMap);
out.emitAttribute("base", ""+baseId);
}
if (!declaringPackage.equals(containingPackage)) {
out.emitAttribute("dpack", declaringPackage.getPackageName());
} else {
code.export(out);
}
out.endElement();
}
public String listComponentReferences(Map componentIdMap) {
FastStringBuffer fsb = new FastStringBuffer(128);
for (ComponentBinding ref : getComponentBindings()) {
Component target = ref.getTarget();
int targetId = obtainComponentId(target, componentIdMap);
if (fsb.length() != 0) {
fsb.append(" ");
}
fsb.append("" + targetId);
}
return fsb.toString();
}
private int obtainComponentId(Component component, Map componentIdMap) {
Integer id = componentIdMap.get(component);
if (id == null) {
id = componentIdMap.size();
componentIdMap.put(component, id);
}
return id;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy