001/*
002 * (C) Copyright 2010 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Anahide Tchertchian
018 */
019package org.nuxeo.ecm.platform.query.core;
020
021import org.nuxeo.common.xmap.annotation.XNode;
022import org.nuxeo.common.xmap.annotation.XObject;
023import org.nuxeo.ecm.core.api.SortInfo;
024
025/**
026 * Descriptor for sort info declaration.
027 *
028 * @author Anahide Tchertchian
029 */
030@XObject("sort")
031public class SortInfoDescriptor {
032
033    @XNode("@column")
034    String column;
035
036    @XNode("@ascending")
037    boolean ascending = true;
038
039    public String getColumn() {
040        return column;
041    }
042
043    public boolean isAscending() {
044        return ascending;
045    }
046
047    public SortInfo getSortInfo() {
048        return new SortInfo(column, ascending);
049    }
050
051    /**
052     * @since 5.6
053     */
054    @Override
055    public SortInfoDescriptor clone() {
056        SortInfoDescriptor clone = new SortInfoDescriptor();
057        clone.column = column;
058        clone.ascending = ascending;
059        return clone;
060    }
061}