SubscribedSource.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: SubscribedSource.java
 * Description: Class representing subscribed source of annotations
 */

/**
 * @file SubscribedSource.java
 *
 * @brief Subscribed source of annotations
 */

package cz.vutbr.fit.knot.annotations.comet;

/**
 * Class representing subscribed source of annotations
 *
 * @brief Subscribed source of annotations
 * @author idytrych
 */
public class SubscribedSource {
  /** Filter for annotation types */
  private String type = null;
  /** Filter for user (must be exact matching) */
  private String user = null;
  /** Filter for URI (must be exact matching) */
  private String uri = null;

  /**
   * Constructor
   *
   * @param type Filter for annotation types
   * @param user URI of user (author of annotation)
   * @param uri URI of source of annotation
   */
  public SubscribedSource (String type, String user, String uri) {
    if (type != null && type.length() > 0) {
      this.type = type;
    }
    if (user != null && user.length() > 0) {
      this.user = user;
    }
    if (uri != null && uri.length() > 0) {
      this.uri = uri;
    }
  }

  /**
   * Gets filter for annotation types
   *
   * @return Returns filter for annotation types
   */
  public String getType() {
    return type;
  }

  /**
   * Gets URI of user (author of annotation)
   *
   * @return Returns URI of user (author of annotation)
   */
  public String getUri() {
    return uri;
  }

  /**
   * Gets URI of source of annotations
   *
   * @return Returns URI of source of annotations
   */
  public String getUser() {
    return user;
  }

  /**
   * Converts string with wildcards (only usable wildcard is "*") to regular
   * expression
   *
   * @param wildStr String with wildcards (only usable wildcard is "*")
   * @return Regular expression
   */
  public static String wildcardToRegex(String wildStr){
    StringBuilder re = new StringBuilder(wildStr.length());
    int wL = wildStr.length();
    re.append('^');
    for (int i = 0; i < wL; i++) {
      char c = wildStr.charAt(i);
      switch(c) {
        case '*':
          re.append(".*");
          break;
        case '(': case ')': case '[': case ']': case '{': case '}':
        case '^': case '$': case '.': case '+':  case '|': case '\\':
        case '?':
          re.append('\\');
          re.append(c);
          break;
        default:
          re.append(c);
          break;
      }
    }
    re.append('$');
    return(re.toString());
  }

  /**
   * Checks whether annotation with given type, user and URI matches this
   * subscription
   *
   * @param type Annotation type
   * @param user Author of annotation
   * @param uri URI of source of annotation
   * @return If informations matches this subscription, returns true, false otherwise
   */
  public boolean matches(String type, String user, String uri) {
    if (this.type != null)
      if (!type.matches(wildcardToRegex(this.type)))
        return false;
    if (this.user != null)
      if (!this.user.equals(user))
        return false;
    if (this.uri != null)
      if (!this.uri.equals(uri) && uri != null)
        return false;
    return true;
  }

  /**
   * Compares this with other object and returns, whether objects are same type
   * and have same content (id is irelevant).
   *
   * @param obj Object to compare with
   * @return If object is same type and have same content, returns true, false otherwise
   */
  @Override
  public boolean equals(Object obj) {
    if (this == obj) return true;
    if (!(obj instanceof SubscribedSource)) return false;
    SubscribedSource su = (SubscribedSource)obj;
    if (su.getType() != null && this.type != null)
      if (!su.getType().equals(this.type))
        return false;
    if (su.getUser() != null && this.user != null)
      if (!su.getUser().equals(this.user))
        return false;
    if (su.getUri() != null && this.uri != null)
      if (!su.getUri().equals(this.uri))
        return false;
    if ((su.getType() != null) && (this.type == null))
      return false;
    if ((su.getUser() != null) && (this.user == null))
      return false;
    if ((su.getUri() != null) && (this.uri == null))
      return false;
    if ((su.getType() == null) && (this.type != null))
      return false;
    if ((su.getUser() == null) && (this.user != null))
      return false;
    if ((su.getUri() == null) && (this.uri != null))
      return false;
    return true;
  }

  /**
   * Returns hash code of this object. Hash is based on type, user and uri attribute.
   * 
   * @return Hash code
   */
  @Override
  public int hashCode() {
    int hash = 7;
    hash = 47 * hash + (this.type != null ? this.type.hashCode() : 0);
    hash = 47 * hash + (this.user != null ? this.user.hashCode() : 0);
    hash = 47 * hash + (this.uri != null ? this.uri.hashCode() : 0);
    return hash;
  }
          
}  // class SubscribedSource