VisorQueryIndexField.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.ignite.internal.visor.query;

import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import org.apache.ignite.cache.QueryEntity;
import org.apache.ignite.cache.QueryIndex;
import org.apache.ignite.internal.util.typedef.internal.S;
import org.apache.ignite.internal.util.typedef.internal.U;
import org.apache.ignite.internal.visor.VisorDataTransferObject;

/**
 * Data transfer object for {@link QueryEntity}.
 */
public class VisorQueryIndexField extends VisorDataTransferObject {
    /** */
    private static final long serialVersionUID = 0L;

    /** Index field name. */
    private String fldName;

    /** Index field sort order. */
    private boolean fldSort;

    /**
     * Create data transfer object for given cache type metadata.
     */
    public VisorQueryIndexField() {
        // No-op.
    }

    /**
     * Create data transfer object for given cache type metadata.
     *
     * @param fldName Index field name.
     * @param fldSort Index field sort order.
     */
    public VisorQueryIndexField(String fldName, boolean fldSort) {
        this.fldName = fldName;
        this.fldSort = fldSort;
    }

    /**
     * @param idx Query entity index.
     * @return Data transfer object for query entity index fields.
     */
    public static List<VisorQueryIndexField> list(QueryIndex idx) {
        List<VisorQueryIndexField> res = new ArrayList<>();

        for (Map.Entry<String, Boolean> field: idx.getFields().entrySet())
            res.add(new VisorQueryIndexField(field.getKey(), !field.getValue()));

        return res;
    }

    /**
     * @return Index field name.
     */
    public String getFieldName() {
        return fldName;
    }

    /**
     * @return Index field sort order.
     */
    public boolean isFieldSort() {
        return fldSort;
    }

    /** {@inheritDoc} */
    @Override protected void writeExternalData(ObjectOutput out) throws IOException {
        U.writeString(out, fldName);
        out.writeBoolean(fldSort);
    }

    /** {@inheritDoc} */
    @Override protected void readExternalData(byte protoVer, ObjectInput in) throws IOException, ClassNotFoundException {
        fldName = U.readString(in);
        fldSort = in.readBoolean();
    }

    /** {@inheritDoc} */
    @Override public String toString() {
        return S.toString(VisorQueryIndexField.class, this);
    }
}