com.couchbase.lite.PropertyExpression Maven / Gradle / Ivy

Go to download
//
// Copyright (c) 2020, 2017 Couchbase, Inc All rights reserved.
//
// Licensed 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 com.couchbase.lite;

import android.support.annotation.NonNull;

import java.util.ArrayList;
import java.util.List;


/**
 * Property expression
 */
public final class PropertyExpression extends Expression {
    static final String PROPS_ALL = "";

    static PropertyExpression allFrom(String from) {
        // Use data source alias name as the column name if specified:
        return new PropertyExpression(PROPS_ALL, from, (from != null ? from : PROPS_ALL));
    }

    private final String keyPath;
    private final String fromAlias; // Data Source Alias
    private String columnName;

    PropertyExpression(String keyPath) { this(keyPath, null); }

    private PropertyExpression(String keyPath, String from) { this(keyPath, from, null); }

    //---------------------------------------------
    // public level access
    //---------------------------------------------

    private PropertyExpression(String keyPath, String from, String columnName) {
        this.keyPath = keyPath;
        this.fromAlias = from;
        this.columnName = columnName;
    }

    //---------------------------------------------
    // package level access
    //---------------------------------------------

    /**
     * Specifies an alias name of the data source to query the data from.
     *
     * @param alias The alias name of the data source.
     * @return The property Expression with the given data source alias name.
     */
    @NonNull
    public Expression from(String alias) {
        return new PropertyExpression(this.keyPath, alias);
    }

    @Override
    Object asJSON() {
        final List