com.cyc.query.QueryAnswersImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cyc-query-client Show documentation
Query API implementation for requesting and handling answers to arbitrarily complex questions posed to a Cyc server.
There is a newer version: 1.2.2
/*
 * Copyright 2017 Cycorp, Inc..
 *
 * 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.cyc.query;

/*
 * #%L
 * File: QueryAnswersImpl.java
 * Project: Query Client
 * %%
 * Copyright (C) 2013 - 2017 Cycorp, Inc.
 * %%
 * 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.
 * #L%
 */

import com.cyc.kb.Variable;
import com.cyc.query.exception.QueryRuntimeException;
import java.io.PrintStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

/**
 *
 * @author nwinant
 * @param 
 */
public class QueryAnswersImpl 
        extends ArrayList
        implements QueryAnswers {
  
  // Construction
  
  public QueryAnswersImpl(Collection answers) {
    super(answers);
  }
  
  public QueryAnswersImpl(int size) {
    super(size);
  }
  
  public QueryAnswersImpl() {
    super();
  }
  
  
  // Public methods
  
  @Override
  public  List getBindingsForVariable(Variable var) {
    final List results = new ArrayList();
    for (QueryAnswer answer : this) {
      results.add(answer.getBinding(var));
    }
    return results;
  }
  
  @Override
  public  List getBindingsForSingleVariableQuery() {
    final Variable var = findSoleVariable();
    return (var != null) ? this.getBindingsForVariable(var) : new ArrayList();
  }
  
  @Override
  public  T getBindingForSingleAnswerQuery(Variable var) {
    if (size() > 1) {
      final List bindings = new ArrayList();
      for (QueryAnswer answer : this) {
        bindings.add("" + answer.getBinding(var));
      }
      final String msg
              = "Expected exactly one binding for " + var 
              + " but found " + size() + ": " + bindings;
      throw new QueryRuntimeException(msg);
    }
    return (size() == 1) ? get(0).getBinding(var) : null;
  }
  
  @Override
  public  T getBindingForSingleVariableSingleAnswerQuery() {
    return this.getBindingForSingleAnswerQuery(findSoleVariable());
  }

  @Override
  public List toAnswersTableStrings(boolean includeOuterBorder, String colBorder, String colPadding) {
    final List results = new ArrayList();
    final List vars = (!isEmpty())
            ? new ArrayList(get(0).getVariables()) 
            : new ArrayList();
    final int[] longestVarLength = new int[vars.size()];
    for (int i = 0; i < vars.size(); i++) {
      final int currLongest = longestVarLength[i];
      final int varLength = vars.get(i).toString().length();
      longestVarLength[i] = (varLength > currLongest) ? varLength : currLongest;
    }
    for (QueryAnswer answer : this) {
      for (int i = 0; i < vars.size(); i++) {
        final int currLongest = longestVarLength[i];
        final int varLength = (answer.hasBinding(vars.get(i))) ? ("" + answer.getBinding(vars.get(i))).length() :  0;
        longestVarLength[i] = (varLength > currLongest) ? varLength : currLongest;
      }
    }
    {
      final StringBuilder header = new StringBuilder();
      final StringBuilder headHr = new StringBuilder();
      if (includeOuterBorder) {
        header.append(colBorder).append(colPadding);
        headHr.append(colBorder).append(colPadding);
      }
      header.append("Answer");
      headHr.append("------");
      for (int i = 0; i < vars.size(); i++) {
        final int maxPadding = longestVarLength[i];
        final Variable var = vars.get(i);
        header.append(colPadding).append(colBorder);
        headHr.append(colPadding).append(colBorder);
        header.append(colPadding).append(String.format("%1$-" + maxPadding + "s", var));
        headHr.append(colPadding).append(String.format("%1$-" + maxPadding + "s", "").replace(' ', '-'));
      }
      if (includeOuterBorder) {
        header.append(colPadding).append(colBorder);
        headHr.append(colPadding).append(colBorder);
        results.add(String.format("%1$-" + headHr.toString().length() + "s", "").replace(' ', '-'));
      }
      results.add(header.toString());
      results.add(headHr.toString());
    }
    for (int ansNum = 0; ansNum < this.size(); ansNum++) {
      final QueryAnswer answer = this.get(ansNum);
      final StringBuilder row = new StringBuilder();
      if (includeOuterBorder) {
        row.append(colBorder).append(colPadding);
      }
      row.append(String.format("%1$6d", ansNum));
      for (int i = 0; i < vars.size(); i++) {
        row.append(colPadding).append(colBorder);
        if (answer.hasBinding(vars.get(i))) {
        row.append(colPadding).append(
                String.format("%1$-" + longestVarLength[i] + "s", answer.getBinding(vars.get(i))));
        } else {
          row.append(colPadding).append(String.format("%" + longestVarLength[i] + "s", ""));
        }
              
      }
      if (includeOuterBorder) {
        row.append(colPadding).append(colBorder);
      }
      results.add(row.toString());
    }
    if (includeOuterBorder) {
      results.add(results.get(0));
    }
    return results;
  }
  
  @Override
  public List toAnswersTableStrings(boolean includeOuterBorder) {
    return toAnswersTableStrings(includeOuterBorder, "|", "  ");
  }
  
  @Override
  public void printAnswersTable(PrintStream out, boolean includeOuterBorder, String colBorder, String colPadding) {
    for (String str : toAnswersTableStrings(includeOuterBorder, colPadding, colBorder)) {
      out.println(str);
    }
  }
  
  @Override
  public void printAnswersTable(PrintStream out, boolean includeOuterBorder) {
    for (String str : toAnswersTableStrings(includeOuterBorder)) {
      out.println(str);
    }
  }
  
  
  // Private
  
  private Variable findSoleVariable() {
    if (!isEmpty()) {
      if (get(0).getVariables().size() == 1) {
        return get(0).getVariables().iterator().next();
      }
      throw new QueryRuntimeException(
              "Expected exactly one variable but found " + get(0).getVariables().size());
    }
    return null;
  }
  
}