com.jimmoores.quandl.MetaDataRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of quandl-jersey1 Show documentation
Quandl REST API wrapper for Java
The newest version!
package com.jimmoores.quandl;

import com.jimmoores.quandl.util.ArgumentChecker;
import com.sun.jersey.api.client.WebResource;

/**
 * A class that packages the request for MetaData from Quandl.
 */
public final class MetaDataRequest {
  private static final String EXTENSION = ".json";
  private static final String DATASETS_RELATIVE_URL = "datasets";
  private static final String EXCLUDE_DATA_PARAM = "exclude_data";
  
  private String _quandlCode;

  private MetaDataRequest(final String quandlCode) {
    _quandlCode = quandlCode;
  }
  
  /**
   * Factory method to create a meta data request instance.
   * @param quandlCode the quandl code for the meta data required, not null
   * @return an instance of the MetaDataRequest for the given quandlCode
   */
  public static MetaDataRequest of(final String quandlCode) {
    ArgumentChecker.notNull(quandlCode, "quandlCode");
    return new MetaDataRequest(quandlCode);
  }
  
  /**
   * @return the quandl code
   */
  public String getQuandlCode() {
    return _quandlCode;
  }
  
  /**
   * Append any specified parameters to the provided WebTarget.
   * @param webTarget a web target used by the Jersey Client API, not null
   * @return the WebTarget with any path and query parameters appended
   */
  public WebResource appendPathAndQueryParameters(final WebResource webTarget) {
    ArgumentChecker.notNull(webTarget, "webTarget");
    WebResource resultTarget = webTarget;
    resultTarget = resultTarget.path(DATASETS_RELATIVE_URL);
    resultTarget = resultTarget.path(_quandlCode + EXTENSION);
    resultTarget = resultTarget.queryParam(EXCLUDE_DATA_PARAM, Boolean.TRUE.toString());
    return resultTarget;
  }

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

  @Override
  public boolean equals(final Object obj) {
    if (this == obj) {
      return true;
    }
    if (obj == null) {
      return false;
    }
    if (!(obj instanceof MetaDataRequest)) {
      return false;
    }
    MetaDataRequest other = (MetaDataRequest) obj;
    return _quandlCode.equals(other._quandlCode);
  }
  
  @Override
  public String toString() {
    return "MetaDataRequest[quandlCode=" + _quandlCode + "]";
  }
}