P2BaseTrix.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: P2BaseTrix.java
 * Description: Class that represents base trix triple.
 */

/**
 * @file P2BaseTrix.java
 *
 * @brief Class that represents base trix triple.
 */

/**
 * @package cz.vutbr.fit.knot.annotations.comet.protocolV2_0.P2Trix
 * 
 * @brief Classes which represents trix triples.
 */
package cz.vutbr.fit.knot.annotations.comet.protocolV2_0.P2Trix;

import cz.vutbr.fit.knot.annotations.comet.RequestInfo;
import cz.vutbr.fit.knot.annotations.entity.Annotation;
import cz.vutbr.fit.knot.annotations.entity.attribute.BaseAttribute;
import java.util.ArrayList;

/**
 * Class that represents base trix triple.
 *
 * @brief Class that represents base trix triple.
 */
public class P2BaseTrix {
  
  public P2BaseTrix(String destinationUri){
    this.destinationUri = destinationUri;
  }

  /** Destination of trix triple */
  protected String destinationUri;
  
  /** Attributes name */
  protected String name;
  
  /** URI in ontology */
  protected String uriInOntology;
  
  /** Type of annotation that is linked/nested */
  protected String annotType;
  
  /** Attribute name is from ontology | default value: false */
  protected boolean fromOntology = false;
  
  /** Priority of attribute within annotation */
  protected String priority;

  /** Method that creates Annotation Attribute from trix */
  public ArrayList<BaseAttribute> trixToAnnotAtt(Annotation annot, RequestInfo requestInfo, Integer sparePriority){return null;}
  
  /**
   * Gets destination of trix triple
   * @return The destination Uri of trix triple
   */
  public String getDestinationUri() {
    return destinationUri;
  }

  /**
   * Sets destination of trix triple
   * @param destinationUri The destination Uri of trix triple
   */
  public void setDestinationUri(String destinationUri) {
    this.destinationUri = destinationUri;
  }
  
  /**
   * Gets attributes name
   * @return The name of attribute
   */
  public String getName() {
    return name;
  }

  /**
   * Sets attributes name
   * @param name The name of attribute to set
   */
  public void setName(String name) {
    this.name = name;
  }
  
  /**
   * Gets attributes URI in ontology
   * 
   * @return URI in ontology
   */
  public String getUriInOntology(){
    return uriInOntology;
  }
  
  /**
   * Sets attributes URI in ontology
   * 
   * @param uriInOntology Uri in ontology
   */
  public void setUriInOntology(String uriInOntology){
    this.uriInOntology = uriInOntology;
  }
  
  /**
   * Gets type of annotation that is nested
   * @return The type of annotation that is nested
   */
  public String getAnnotType() {
    return annotType;
  }

  /**
   * Sets type of annotation that is nested
   * @param annotType The type of annotation to set
   */
  public void setAnnotType(String annotType) {
    this.annotType = annotType;
  }
  
  /**
   * Gets boolean value that indicates if name of attribute is from ontology
   * @return true if name is from ontology, false otherwise
   */
  public boolean isFromOntology() {
    return fromOntology;
  }

  /**
   * Sets boolean value that indicates that name of attribute is from ontology
   * @param fromOntology Boolean value that indicates that name of attribute is from ontology
   */
  public void setFromOntology(boolean fromOntology) {
    this.fromOntology = fromOntology;
  }
  
  /**
   * Gets attributes priority
   * @return The priority of attribute within annotation
   */
  public String getPriority(){
    return priority;
  }
  
  /**
   * Sets attributes priority
   * @param priority The priority of attribute within annotation
   */
  public void setPriority(String priority){
    this.priority = priority;
  }
  
}