nlpcraft/src/main/scala/org/apache/nlpcraft/model/tools/sqlgen/NCSqlLimit.java

/*
 * 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.
 */

package org.apache.nlpcraft.model.tools.sqlgen;

import org.apache.nlpcraft.model.*;

/**
 * Object presentation of SQL limit.
 *
 * @see NCSqlSchemaBuilder#makeSchema(NCModel)
 * @see NCSqlExtractor#extractLimit(NCToken) 
 */
public interface NCSqlLimit {
    /**
     * Gets SQL column this limit is applied to.
     *
     * @return SQL column this limit is applied to.
     */
    NCSqlColumn getColumn();

    /**
     * Gets the numeric value of the limit.
     *
     * @return Numeric value of the limit.
     */
    int getLimit();

    /**
     * Gets whether limit ascending or descending.
     *
     * @return Whether limit ascending or descending.
     */
    boolean isAscending();
}