001/*
002 * (C) Copyright 2010 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Anahide Tchertchian
016 */
017package org.nuxeo.ecm.platform.query.core;
018
019import org.nuxeo.common.xmap.annotation.XNode;
020import org.nuxeo.common.xmap.annotation.XObject;
021import org.nuxeo.ecm.core.api.SortInfo;
022
023/**
024 * Descriptor for sort info declaration.
025 *
026 * @author Anahide Tchertchian
027 */
028@XObject("sort")
029public class SortInfoDescriptor {
030
031    @XNode("@column")
032    String column;
033
034    @XNode("@ascending")
035    boolean ascending = true;
036
037    public String getColumn() {
038        return column;
039    }
040
041    public boolean isAscending() {
042        return ascending;
043    }
044
045    public SortInfo getSortInfo() {
046        return new SortInfo(column, ascending);
047    }
048
049    /**
050     * @since 5.6
051     */
052    @Override
053    public SortInfoDescriptor clone() {
054        SortInfoDescriptor clone = new SortInfoDescriptor();
055        clone.column = column;
056        clone.ascending = ascending;
057        return clone;
058    }
059}