com.sun.org.apache.xalan.internal.xsltc.dom.SortSettings 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: SortSettings.java,v 1.10 2010-11-01 04:34:25 joehw Exp $
*/
package com.sun.org.apache.xalan.internal.xsltc.dom;
import java.text.Collator;
import java.util.Locale;
import com.sun.org.apache.xalan.internal.xsltc.runtime.AbstractTranslet;
/**
* Class for carrying settings that are to be used for a particular set
* of xsl:sort
elements.
*/
final class SortSettings {
/**
* A reference to the translet object for the transformation.
*/
private AbstractTranslet _translet;
/**
* The sort order (ascending or descending) for each level of
* xsl:sort
*/
private int[] _sortOrders;
/**
* The type of comparison (text or number) for each level of
* xsl:sort
*/
private int[] _types;
/**
* The Locale for each level of xsl:sort
, based on any lang
* attribute or the default Locale.
*/
private Locale[] _locales;
/**
* The Collator object in effect for each level of xsl:sort
*/
private Collator[] _collators;
/**
* Case ordering for each level of xsl:sort
.
*/
private String[] _caseOrders;
/**
* Create an instance of SortSettings
.
* @param translet {@link com.sun.org.apache.xalan.internal.xsltc.runtime.AbstractTranslet}
* object for the transformation
* @param sortOrders an array specifying the sort order for each sort level
* @param types an array specifying the type of comparison for each sort
* level (text or number)
* @param locales an array specifying the Locale for each sort level
* @param collators an array specifying the Collation in effect for each
* sort level
* @param caseOrders an array specifying whether upper-case, lower-case
* or neither is to take precedence for each sort level.
* The value of each element is equal to one of
* "upper-first", "lower-first", or ""
.
*/
SortSettings(AbstractTranslet translet, int[] sortOrders, int[] types,
Locale[] locales, Collator[] collators, String[] caseOrders) {
_translet = translet;
_sortOrders = sortOrders;
_types = types;
_locales = locales;
_collators = collators;
_caseOrders = caseOrders;
}
/**
* @return A reference to the translet object for the transformation.
*/
AbstractTranslet getTranslet() {
return _translet;
}
/**
* @return An array containing the sort order (ascending or descending)
* for each level of xsl:sort
*/
int[] getSortOrders() {
return _sortOrders;
}
/**
* @return An array containing the type of comparison (text or number)
* to perform for each level of xsl:sort
*/
int[] getTypes() {
return _types;
}
/**
* @return An array containing the Locale object in effect for each level
* of xsl:sort
*/
Locale[] getLocales() {
return _locales;
}
/**
* @return An array containing the Collator object in effect for each level
* of xsl:sort
*/
Collator[] getCollators() {
return _collators;
}
/**
* @return An array specifying the case ordering for each level of
* xsl:sort
.
*/
String[] getCaseOrders() {
return _caseOrders;
}
}