sdmxdl.DataCursor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdmx-dl-api Show documentation
Easily download official statistics - API
There is a newer version: 3.0.0-beta.13
/*
 * Copyright 2015 National Bank of Belgium
 *
 * Licensed under the EUPL, Version 1.1 or - as soon they will be approved
 * by the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at:
 *
 * http://ec.europa.eu/idabc/eupl
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing permissions and
 * limitations under the Licence.
 */
package sdmxdl;

import internal.sdmxdl.EmptyCursor;
import internal.sdmxdl.FilteredCursor;
import internal.sdmxdl.SeriesCursor;
import internal.sdmxdl.SeriesIterator;
import nbbrd.design.NotThreadSafe;
import nbbrd.design.StaticFactoryMethod;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.checkerframework.checker.nullness.qual.Nullable;

import java.io.Closeable;
import java.io.IOException;
import java.time.LocalDateTime;
import java.util.Iterator;
import java.util.Map;
import java.util.Spliterator;
import java.util.Spliterators;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;

/**
 * @author Philippe Charles
 */
@NotThreadSafe
public interface DataCursor extends Closeable {

    boolean nextSeries() throws IOException;

    @NonNull
    Key getSeriesKey() throws IOException, IllegalStateException;

    @NonNull
    Frequency getSeriesFrequency() throws IOException, IllegalStateException;

    @Nullable
    String getSeriesAttribute(@NonNull String key) throws IOException, IllegalStateException;

    @NonNull
    Map getSeriesAttributes() throws IOException, IllegalStateException;

    boolean nextObs() throws IOException, IllegalStateException;

    @Nullable
    LocalDateTime getObsPeriod() throws IOException, IllegalStateException;

    @Nullable
    Double getObsValue() throws IOException, IllegalStateException;

    @NonNull
    Map getObsAttributes() throws IOException, IllegalStateException;

    @NonNull
    default Stream toStream() {
        Iterator iterator = SeriesIterator.of(this);
        return StreamSupport.stream(Spliterators.spliteratorUnknownSize(iterator, Spliterator.ORDERED | Spliterator.NONNULL), false);
    }

    @NonNull
    default DataCursor filter(@NonNull Key ref, @NonNull DataFilter filter) {
        return FilteredCursor.of(this, ref, filter);
    }

    @StaticFactoryMethod
    @NonNull
    static DataCursor empty() {
        return new EmptyCursor();
    }

    @StaticFactoryMethod
    @NonNull
    static DataCursor of(@NonNull Iterator list) {
        return SeriesCursor.of(list);
    }
}