com.sun.org.apache.xalan.internal.lib.ExsltCommon Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaxp-ri Show documentation
Show all versions of jaxp-ri Show documentation
Java API for XML Processing Reference Implementation
The newest version!
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*
*
* This file incorporates work covered by the following copyright and
* permission notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* $Id: ExsltCommon.java,v 1.10 2010-11-01 04:34:11 joehw Exp $
*/
package com.sun.org.apache.xalan.internal.lib;
import com.sun.org.apache.xalan.internal.extensions.ExpressionContext;
import com.sun.org.apache.xml.internal.dtm.DTMIterator;
import com.sun.org.apache.xml.internal.dtm.ref.DTMNodeIterator;
import com.sun.org.apache.xpath.internal.NodeSet;
/**
* This class contains EXSLT common extension functions.
* It is accessed by specifying a namespace URI as follows:
*
* xmlns:exslt="http://exslt.org/common"
*
*
* The documentation for each function has been copied from the relevant
* EXSLT Implementer page.
*
* @see EXSLT
* @xsl.usage general
*/
public class ExsltCommon
{
/**
* The exsl:object-type function returns a string giving the type of the object passed
* as the argument. The possible object types are: 'string', 'number', 'boolean',
* 'node-set', 'RTF', or 'external'.
*
* Most XSLT object types can be coerced to each other without error. However, there are
* certain coercions that raise errors, most importantly treating anything other than a
* node set as a node set. Authors of utilities such as named templates or user-defined
* extension functions may wish to give some flexibility in the parameter and argument values
* that are accepted by the utility; the exsl:object-type function enables them to do so.
*
* The Xalan extensions MethodResolver converts 'object-type' to 'objectType'.
*
* @param obj The object to be typed.
* @return objectType 'string', 'number', 'boolean', 'node-set', 'RTF', or 'external'.
*
* @see EXSLT
*/
public static String objectType (Object obj)
{
if (obj instanceof String)
return "string";
else if (obj instanceof Boolean)
return "boolean";
else if (obj instanceof Number)
return "number";
else if (obj instanceof DTMNodeIterator)
{
DTMIterator dtmI = ((DTMNodeIterator)obj).getDTMIterator();
if (dtmI instanceof com.sun.org.apache.xpath.internal.axes.RTFIterator)
return "RTF";
else
return "node-set";
}
else
return "unknown";
}
/**
* The exsl:node-set function converts a result tree fragment (which is what you get
* when you use the content of xsl:variable rather than its select attribute to give
* a variable value) into a node set. This enables you to process the XML that you create
* within a variable, and therefore do multi-step processing.
*
* You can also use this function to turn a string into a text node, which is helpful
* if you want to pass a string to a function that only accepts a node set.
*
* The Xalan extensions MethodResolver converts 'node-set' to 'nodeSet'.
*
* @param myProcessor is passed in by the Xalan extension processor
* @param rtf The result tree fragment to be converted to a node-set.
*
* @return node-set with the contents of the result tree fragment.
*
* Note: Already implemented in the xalan namespace as nodeset.
*
* @see EXSLT
*/
public static NodeSet nodeSet(ExpressionContext myProcessor, Object rtf)
{
return Extensions.nodeset(myProcessor, rtf);
}
}