org.hisp.dhis.model.event.Event 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.
There is a newer version: 2.0.4
package org.hisp.dhis.model.event;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Objects;

import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;

import com.fasterxml.jackson.annotation.JsonProperty;

@Getter
@Setter
@NoArgsConstructor
@EqualsAndHashCode( onlyExplicitlyIncluded = true )
@ToString( onlyExplicitlyIncluded = true )
public class Event
{
    @EqualsAndHashCode.Include
    @ToString.Include
    @JsonProperty( value = "event" )
    private String id;

    @JsonProperty
    private String program;

    @ToString.Include
    @JsonProperty
    private String programStage;

    @ToString.Include
    @JsonProperty
    private String enrollment;

    @ToString.Include
    @JsonProperty
    private String attributeOptionCombo;

    @JsonProperty
    private EventStatus status = EventStatus.ACTIVE;

    @ToString.Include
    @JsonProperty
    private String orgUnit;

    @JsonProperty
    private Date createdAt;

    @JsonProperty
    private Date createdAtClient;

    @JsonProperty
    private Date updatedAt;

    @JsonProperty
    private Date updatedAtClient;

    @JsonProperty
    private Date scheduledAt;

    @JsonProperty
    private Date occurredAt;

    @JsonProperty
    private String completedBy;

    @JsonProperty
    private String storedBy;

    @JsonProperty
    private Boolean followUp;

    @JsonProperty
    private Boolean deleted;

    private List dataValues = new ArrayList<>();

    public Event( String id )
    {
        this.id = id;
    }

    public Event( String id, String program, String programStage,
        String orgUnit, Date occurredAt, List dataValues )
    {
        this( id );
        this.program = program;
        this.programStage = programStage;
        this.orgUnit = orgUnit;
        this.occurredAt = occurredAt;
        this.dataValues = dataValues;
    }

    /**
     * Returns the first {@link EventDataValue} which data element matches the
     * given data element identifier, or null if no match.
     *
     * @param dataElement the data element identifier.
     * @return a {@link EventDataValue} or null.
     */
    public EventDataValue getEventDataValue( String dataElement )
    {
        return dataValues.stream()
            .filter( dv -> dataElement.equals( dv.getDataElement() ) )
            .findFirst()
            .orElse( null );
    }

    /**
     * Returns the value of the first {@link EventDataValue} which data element
     * matches the given data element identifier, or null if no match.
     *
     * @param dataElement the data element identifier.
     * @return a {@link EventDataValue} or null.
     */
    public String getDataValue( String dataElement )
    {
        EventDataValue eventDataValue = getEventDataValue( dataElement );
        return eventDataValue != null ? eventDataValue.getValue() : null;
    }

    /**
     * Adds a data value. If a data value with the same data element identifier
     * exists, the given value will overwrite the existing data value. The new
     * data value is added to the end of the list of data values.
     *
     * @param dataValue the {@link EventDataValue}, not null.
     */
    public void addDataValue( EventDataValue dataValue )
    {
        Objects.requireNonNull( dataValue );
        Objects.requireNonNull( dataValue.getDataElement() );

        this.dataValues.removeIf( dv -> dv.getDataElement().equals( dataValue.getDataElement() ) );
        this.dataValues.add( dataValue );
    }

    /**
     * Adds a data value. If a data value with the same data element identifier
     * exists, the given value will overwrite the existing data value. The new
     * data value is added to the end of the list of data values.
     *
     * @param dataElement the data element identifier, not null.
     * @param value the data value.
     */
    public void addDataValue( String dataElement, String value )
    {
        addDataValue( new EventDataValue( dataElement, value ) );
    }
}