org.hisp.dhis.query.analytics.AnalyticsQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dhis2-java-client Show documentation
DHIS 2 API client for Java.
The newest version!
/*
 * Copyright (c) 2004-2024, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * Neither the name of the HISP project nor the names of its contributors may
 * be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.query.analytics;

import java.util.ArrayList;
import java.util.List;
import lombok.Getter;
import lombok.Setter;
import lombok.experimental.Accessors;
import org.hisp.dhis.model.AggregationType;
import org.hisp.dhis.model.IdScheme;

@Getter
@Setter
@Accessors(chain = true)
public class AnalyticsQuery {
  private final List dimensions = new ArrayList<>();

  private final List filters = new ArrayList<>();

  private AggregationType aggregationType;

  private String startDate;

  private String endDate;

  private Boolean skipMeta;

  private Boolean skipData;

  private Boolean skipRounding;

  private Boolean ignoreLimit;

  private IdScheme outputIdScheme;

  private IdScheme inputIdScheme;

  private AnalyticsQuery() {}

  public static AnalyticsQuery instance() {
    return new AnalyticsQuery();
  }

  public AnalyticsQuery addDimension(Dimension dimension) {
    this.dimensions.add(dimension);
    return this;
  }

  public AnalyticsQuery addDimension(String dimension, List items) {
    return addDimension(new Dimension(dimension, items));
  }

  public AnalyticsQuery addFilter(Dimension filter) {
    this.filters.add(filter);
    return this;
  }
}