BwContact.java

/* ********************************************************************
    Licensed to Jasig under one or more contributor license
    agreements. See the NOTICE file distributed with this work
    for additional information regarding copyright ownership.
    Jasig 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.bedework.calfacade;

import org.bedework.calfacade.annotations.Dump;
import org.bedework.calfacade.annotations.NoDump;
import org.bedework.calfacade.annotations.ical.IcalProperty;
import org.bedework.calfacade.base.CollatableEntity;
import org.bedework.calfacade.base.SizedEntity;
import org.bedework.calfacade.configs.BasicSystemProperties;
import org.bedework.calfacade.util.CalFacadeUtil;
import org.bedework.calfacade.util.QuotaUtil;
import org.bedework.util.calendar.PropertyIndex.PropertyInfoIndex;
import org.bedework.util.misc.ToString;
import org.bedework.util.misc.Util;
import org.bedework.util.xml.FromXmlCallback;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;

import java.util.Comparator;

/** Class representing rfc contact information. The phone and email is additional
 * for the web clients.
 *
 * @author Mike Douglass
 * @version 1.0
 */
@Dump(elementName="contact", keyFields={"uid"})
@JsonIgnoreProperties({"size"})
public class BwContact extends BwEventProperty<BwContact>
        implements CollatableEntity, Comparator<BwContact>,
                   SizedEntity {
  private BwString cn;  // The rfc value
  private String phone;
  private String email;
  private String link;  // The rfc altrep

  private String href;

  /** Constructor
   *
   */
  public BwContact() {
    super();
  }

  /** Set the name
   *
   * @param val    BwString name
   */
  @IcalProperty(pindex = PropertyInfoIndex.CN)
  public void setCn(final BwString val) {
    cn = val;
  }

  /** Get the name
   *
   * @return BwString   name
   */
  public BwString getCn() {
    return cn;
  }

  /**
   * @param val phone number
   */
  @IcalProperty(pindex = PropertyInfoIndex.PHONE)
  public void setPhone(final String val) {
    phone = val;
  }

  /**
   * @return String phone number
   */
  public String getPhone() {
    return phone;
  }

  /**
   * @param val email
   */
  @IcalProperty(pindex = PropertyInfoIndex.EMAIL)
  public void setEmail(final String val) {
    email = val;
  }

  /**
   * @return String email
   */
  public String getEmail() {
    return email;
  }

  /** Set the sponsor's URL
   *
   * @param link   String URL
   */
  public void setLink(final String link) {
    this.link = link;
  }

  /**
   * @return String url
   */
  public String getLink() {
    return link;
  }

  /**
   * @return contact with uid filled in.
   */
  public static BwContact makeContact() {
    return (BwContact)new BwContact().initUid();
  }

  /** Delete the contact's name - this must be called rather than setting
   * the value to null.
   *
   */
  public void deleteName() {
    addDeletedEntity(getCn());
    setCn(null);
  }

  /* ====================================================================
   *                   FixNamesEntity methods
   * ==================================================================== */

  @Override
  public void fixNames(final BasicSystemProperties props,
                       final BwPrincipal principal) {
    if (getHref() != null) {
      return;
    }

    setColPath(props, principal, "contacts", null);

    setHref(Util.buildPath(false, getColPath(), getUid()));
  }

  @Override
  public void setHref(final String val) {
    href = val;
  }

  @Override
  public String getHref(){
    return href;
  }

  public void setStatus(final String val) {
    if (getCn() == null) {
      setCn(new BwString(val, null));
    } else {
      getCn().setLang(val);
    }
  }

  /**
   * @return String
   */
  @NoDump
  public String getStatus() {
    final BwString s = getCn();
    if (s == null) {
      return null;
    }

    return s.getLang();
  }

  /* ====================================================================
   *                   EventProperty methods
   * ==================================================================== */

  /* (non-Javadoc)
   * @see org.bedework.calfacade.BwEventProperty#getFinderKeyValue()
   */
  @Override
  @NoDump
  public BwString getFinderKeyValue() {
    return getCn();
  }

  /* ====================================================================
   *                   CollatableEntity methods
   * ==================================================================== */

  @Override
  @NoDump
  public String getCollateValue() {
    return getCn().getValue();
  }

  /* ====================================================================
   *                   Action methods
   * ==================================================================== */

  @Override
  public void afterDeletion() {
    addDeletedEntity(getCn());
  }

  /** Size to use for quotas.
   *
   * @return int
   */
  @Override
  @NoDump
  public int getSize() {
    return super.length() +
           QuotaUtil.size(getCn()) +
           QuotaUtil.size(getPhone()) +
           QuotaUtil.size(getEmail()) +
           QuotaUtil.size(getLink());
  }

  public boolean updateFrom(final BwContact ent) {
    boolean changed = false;

    if (!CalFacadeUtil.eqObjval(getCn(), ent.getCn())) {
      setCn(ent.getCn());
      changed = true;
    }

    if (!CalFacadeUtil.eqObjval(getPhone(), ent.getPhone())) {
      setPhone(ent.getPhone());
      changed = true;
    }

    if (!CalFacadeUtil.eqObjval(getEmail(), ent.getEmail())) {
      setEmail(ent.getEmail());
      changed = true;
    }

    if (!CalFacadeUtil.eqObjval(getLink(), ent.getLink())) {
      setLink(ent.getLink());
      changed = true;
    }

    return changed;
  }

  /* ====================================================================
   *                   Restore callback
   * ==================================================================== */

  private static FromXmlCallback fromXmlCb;

  @NoDump
  public static FromXmlCallback getRestoreCallback() {
    if (fromXmlCb == null) {
      fromXmlCb = new FromXmlCallback();

      fromXmlCb.addSkips("byteSize",
                         "id",
                         "seq");

      fromXmlCb.addMapField("public", "publick");
    }

    return fromXmlCb;
  }

  /* ====================================================================
   *                   Object methods
   * ==================================================================== */

  @Override
  public int compare(final BwContact thisone, final BwContact thatone) {
    if (thisone.equals(thatone)) {
      return 0;
    }

    return CalFacadeUtil.cmpObjval(thisone.getCn().getValue(),
                                   thatone.getCn().getValue());
  }

  @Override
  public int compareTo(final BwContact that) {
    if (this == that) {
      return 0;
    }

    return CalFacadeUtil.cmpObjval(getUid(), that.getUid());
  }

  @Override
  public int hashCode() {
    return getUid().hashCode();
  }

  @Override
  public String toString() {
    final ToString ts = new ToString(this);

    toStringSegment(ts);
    ts.append("uid", getUid());
    ts.append("cn", getCn());
    ts.append("phone", getPhone());
    ts.append("email", getEmail());
    ts.append("link", getLink());

    return ts.toString();
  }

  @Override
  public Object clone() {
    final BwContact sp = new BwContact();

    super.copyTo(sp);

    sp.setCn((BwString)getCn().clone());
    sp.setPhone(getPhone());
    sp.setEmail(getEmail());
    sp.setLink(getLink());

    return sp;
  }
}