org.apache.flink.table.client.cli.CliRowView Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-sql-client Show documentation
This module contains the SQL Client for exploring and submitting SQL programs to Flink.
There is a newer version: 2.0-preview1
/*
 * 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.flink.table.client.cli;

import org.jline.keymap.KeyMap;
import org.jline.utils.AttributedString;
import org.jline.utils.AttributedStringBuilder;
import org.jline.utils.AttributedStyle;
import org.jline.utils.InfoCmp.Capability;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.stream.IntStream;

import static org.jline.keymap.KeyMap.esc;
import static org.jline.keymap.KeyMap.key;

/**
 * CLI view for visualizing a row.
 */
public class CliRowView extends CliView {

	private String[] columnNames;

	private String[] columnTypes;

	private String[] row;

	public CliRowView(CliClient client, String[] columnNames, String[] columnTypes, String[] row) {
		super(client);

		this.columnNames = columnNames;
		this.columnTypes = columnTypes;
		this.row = row;
	}

	// --------------------------------------------------------------------------------------------

	@Override
	protected void init() {
		// nothing to do
	}

	@Override
	protected KeyMap getKeys() {
		final KeyMap keys = new KeyMap<>();
		keys.setAmbiguousTimeout(200); // make ESC quicker
		keys.bind(RowOperation.QUIT, "q", "Q", esc());
		keys.bind(RowOperation.UP, "w", "W", key(client.getTerminal(), Capability.key_up));
		keys.bind(RowOperation.DOWN, "s", "S", key(client.getTerminal(), Capability.key_down));
		keys.bind(RowOperation.LEFT, "a", "A", key(client.getTerminal(), Capability.key_left));
		keys.bind(RowOperation.RIGHT, "d", "D", key(client.getTerminal(), Capability.key_right));
		return keys;
	}

	@Override
	protected void evaluate(RowOperation operation, String binding) {
		switch (operation) {
			case QUIT:
				close();
				break;
			case UP:
				scrollUp();
				break;
			case DOWN:
				scrollDown();
				break;
			case LEFT:
				scrollLeft();
				break;
			case RIGHT:
				scrollRight();
				break;
		}
	}

	@Override
	protected String getTitle() {
		return CliStrings.ROW_HEADER;
	}

	@Override
	protected List computeHeaderLines() {
		return Collections.singletonList(AttributedString.EMPTY);
	}

	@Override
	protected List computeFooterLines() {
		return Collections.singletonList(CliStrings.ROW_QUIT);
	}

	@Override
	protected List computeMainHeaderLines() {
		return Collections.emptyList();
	}

	@Override
	protected List computeMainLines() {
		final List lines = new ArrayList<>();

		final AttributedStringBuilder sb = new AttributedStringBuilder();
		IntStream.range(0, row.length).forEach(i -> {
			final String name = columnNames[i];
			final String type = columnTypes[i];

			sb.setLength(0);
			sb.append(CliStrings.DEFAULT_MARGIN);
			sb.style(AttributedStyle.BOLD);
			sb.append(name);
			sb.append(" (");
			sb.append(type);
			sb.append(')');
			sb.append(':');
			lines.add(sb.toAttributedString());

			sb.setLength(0);
			sb.append(CliStrings.DEFAULT_MARGIN);
			sb.style(AttributedStyle.DEFAULT);
			sb.append(row[i]);
			lines.add(sb.toAttributedString());

			lines.add(AttributedString.EMPTY);
		});

		return lines;
	}

	@Override
	protected void cleanUp() {
		// nothing to do
	}

	// --------------------------------------------------------------------------------------------

	/**
	 * Available operations for this view.
	 */
	public enum RowOperation {
		QUIT, // leave row view
		UP,
		DOWN,
		LEFT,
		RIGHT
	}
}