com.fluxtion.ext.streaming.api.group.GroupBy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fluxtion-streaming-api Show documentation
There is a newer version: 2.10.50
Show newest version
/*
 * Copyright (C) 2018 V12 Technology Ltd.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program.  If not, see
 * .
 */
package com.fluxtion.ext.streaming.api.group;

import static com.fluxtion.api.SepContext.service;
import com.fluxtion.ext.streaming.api.ArrayListWrappedCollection;
import com.fluxtion.ext.streaming.api.Duration;
import com.fluxtion.ext.streaming.api.FilterWrapper;
import com.fluxtion.ext.streaming.api.WrappedCollection;
import com.fluxtion.ext.streaming.api.WrappedList;
import com.fluxtion.ext.streaming.api.Wrapper;
import com.fluxtion.ext.streaming.api.stream.StreamOperator;
import com.fluxtion.ext.streaming.api.test.BooleanFilter;
import com.fluxtion.ext.streaming.api.window.WindowBuildOperations;
import java.util.Collection;
import java.util.Map;

/**
 * Runtime interface for GroupBy instances generated by SEP.
 *
 * @param  he target type of the group
 * @author greg
 */
public interface GroupBy extends WrappedCollection, GroupBy> {

     T value(K key);

    > Map getMap();

    @Override
    default GroupBy id(String id) {
        return StreamOperator.service().nodeId(this, id);
    }

    @Override
    default GroupBy resetNotifier(Object resetNotifier) {
        return this;
    }

    @Override
    default GroupBy sliding(int itemsPerBucket, int numberOfBuckets) {
        GroupBy sliding = WindowBuildOperations.service().sliding(self(), itemsPerBucket, numberOfBuckets);
        return sliding;
    }

    @Override
    default GroupBy sliding(Duration timePerBucket, int numberOfBuckets) {
        GroupBy sliding = WindowBuildOperations.service().sliding(self(), timePerBucket, numberOfBuckets);
        return sliding;
    }

    @Override
    default GroupBy tumbling(Duration time) {
        GroupBy sliding = WindowBuildOperations.service().tumbling(self(), time);
        return sliding;
    }

    @Override
    default GroupBy tumbling(int itemCount) {
        GroupBy sliding = WindowBuildOperations.service().tumbling(self(), itemCount);
        return sliding;
    }

    @Override
    public default void reset() {
        throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
    }

    /**
     * The last record that was updated as a wrapped node
     *
     * @return the wrapped node
     */
    T record();

    /**
     * The type of the wrapped node
     *
     * @return wrapped node class
     */
    Class recordClass();

    /**
     * Set the target collection for storing results of the groupBy operations. If no target is supplied then an
     * internal
     * list is used.
     *
     * @param wrappedList
     */
    default void setTargetCollecion(ArrayListWrappedCollection wrappedList) {
    }

    GroupBy newInstance();

    /**
     * Attaches an event notification instance to the current stream node,
     * overriding the execution path of the current stream.Only when the
     * notifier updates will the child nodes of this stream node be on the
     * execution path.
     *
     * @param notifier
     * @param eventNotifier external event notifier
     * @return
     */
    default Wrapper> notifierOverride(Object notifier) {
        BooleanFilter> filter = new BooleanFilter<>(service().addOrReuse(self()), service().addOrReuse(notifier));
        service().addOrReuse(filter);
        return filter;
    }
}