com.cyc.nl.ParaphraseImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cyc-kb-client Show documentation
KB API implementation for representing CycL structures as Java objects.
There is a newer version: 1.2.2
package com.cyc.nl;

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

/*
 * #%L
 * File: ParaphraseImpl.java
 * Project: KB 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%
 */
/**
 * A class that bundles information about the rendering of a term in a natural language.
 *
 * @author baxter
 * @param 
 */
public class ParaphraseImpl implements Paraphrase {

  /**
   * Creates a new Paraphrase with the specified term and nl.
   *
   * @param nl
   * @param term
   */
  public ParaphraseImpl(String nl, C term) {
    this.nl = nl;
    this.term = term;
  }

  @Override
  public List getSubParaphrases() {
    return subparaphrases;
  }

  /**
   *
   * @param sub
   * @return
   */
  @Override
  public Paraphrase addSubParaphrase(SubParaphrase sub) {
    this.subparaphrases.add(sub);
    return this;
  }
  
  private final List subparaphrases = new ArrayList();

  @Override
  public boolean equals(Object obj) {
    if (obj == null) {
      return false;
    }
    if (getClass() != obj.getClass()) {
      return false;
    }
    final ParaphraseImpl other = (ParaphraseImpl) obj;
    if ((this.nl == null) ? (other.nl != null) : !this.nl.equals(other.nl)) {
      return false;
    }
    if (this.term != other.term && (this.term == null || !this.term.equals(
            other.term))) {
      return false;
    }
    return true;
  }

  @Override
  public int hashCode() {
    int hash = 3;
    hash = 89 * hash + (this.nl != null ? this.nl.hashCode() : 0);
    hash = 89 * hash + (this.term != null ? this.term.hashCode() : 0);
    return hash;
  }

  @Override
  public int compareTo(Paraphrase o) {
    final String thisString = this.nl == null ? "" : this.nl;
    final String oString = o == null || o.getString() == null ? "" : o.getString();
    return thisString.compareTo(oString);
  }

  /**
   * Returns the NL string paraphrasing the term.
   *
   * @return the NL string paraphrasing the term.
   */
  @Override
  public String getString() {
    return nl;
  }

  @Override
  public String toString() {
    return getString();
  }

  /**
   * Returns the CycL term of which this is a paraphrase.
   *
   * @return the CycL term of which this is a paraphrase.
   */
  @Override
  public C getCycl() {
    return term;
  }
  /**
   *
   */
  protected final String nl;
  /**
   *
   */
  protected final C term;



}