org.apache.flink.cep.nfa.sharedbuffer.NodeId Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-cep Show documentation
There is a newer version: 2.0-preview1
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.cep.nfa.sharedbuffer;

import org.apache.flink.api.common.typeutils.CompositeTypeSerializerSnapshot;
import org.apache.flink.api.common.typeutils.TypeSerializer;
import org.apache.flink.api.common.typeutils.TypeSerializerSnapshot;
import org.apache.flink.api.common.typeutils.base.TypeSerializerSingleton;
import org.apache.flink.core.memory.DataInputView;
import org.apache.flink.core.memory.DataOutputView;
import org.apache.flink.types.StringValue;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.util.Objects;

import static org.apache.flink.util.Preconditions.checkNotNull;

/** Unique identifier for {@link SharedBufferNode}. */
public class NodeId {

    private final String pageName;
    private final EventId eventId;

    public NodeId(EventId eventId, String pageName) {
        this.eventId = eventId;
        this.pageName = pageName;
    }

    public EventId getEventId() {
        return eventId;
    }

    public String getPageName() {
        return pageName;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        NodeId nodeId = (NodeId) o;
        return Objects.equals(eventId, nodeId.eventId) && Objects.equals(pageName, nodeId.pageName);
    }

    @Override
    public int hashCode() {
        return Objects.hash(eventId, pageName);
    }

    @Override
    public String toString() {
        return "NodeId{" + "eventId=" + eventId + ", pageName='" + pageName + '\'' + '}';
    }

    /** Serializer for {@link NodeId}. */
    public static class NodeIdSerializer extends TypeSerializerSingleton {

        private static final long serialVersionUID = 9209498028181378582L;

        /**
         * NOTE: this field should actually be final. The reason that it isn't final is due to
         * backward compatible deserialization paths. See {@link #readObject(ObjectInputStream)}.
         */
        private TypeSerializer eventIdSerializer;

        public NodeIdSerializer() {
            this(EventId.EventIdSerializer.INSTANCE);
        }

        private NodeIdSerializer(TypeSerializer eventIdSerializer) {
            this.eventIdSerializer = checkNotNull(eventIdSerializer);
        }

        @Override
        public boolean isImmutableType() {
            return true;
        }

        @Override
        public NodeId createInstance() {
            return null;
        }

        @Override
        public NodeId copy(NodeId from) {
            return new NodeId(from.eventId, from.pageName);
        }

        @Override
        public NodeId copy(NodeId from, NodeId reuse) {
            return copy(from);
        }

        @Override
        public int getLength() {
            return -1;
        }

        @Override
        public void serialize(NodeId record, DataOutputView target) throws IOException {
            if (record != null) {
                target.writeByte(1);
                eventIdSerializer.serialize(record.eventId, target);
                StringValue.writeString(record.pageName, target);
            } else {
                target.writeByte(0);
            }
        }

        @Override
        public NodeId deserialize(DataInputView source) throws IOException {
            byte b = source.readByte();
            if (b == 0) {
                return null;
            }

            EventId eventId = eventIdSerializer.deserialize(source);
            String pageName = StringValue.readString(source);
            return new NodeId(eventId, pageName);
        }

        @Override
        public NodeId deserialize(NodeId reuse, DataInputView source) throws IOException {
            return deserialize(source);
        }

        @Override
        public void copy(DataInputView source, DataOutputView target) throws IOException {
            target.writeByte(source.readByte());

            eventIdSerializer.copy(source, target);
            StringValue.copyString(source, target);
        }

        // ------------------------------------------------------------------------

        @Override
        public TypeSerializerSnapshot snapshotConfiguration() {
            return new NodeIdSerializerSnapshot(this);
        }

        /** Serializer configuration snapshot for compatibility and format evolution. */
        @SuppressWarnings("WeakerAccess")
        public static final class NodeIdSerializerSnapshot
                extends CompositeTypeSerializerSnapshot {

            private static final int VERSION = 1;

            public NodeIdSerializerSnapshot() {}

            public NodeIdSerializerSnapshot(NodeIdSerializer nodeIdSerializer) {
                super(nodeIdSerializer);
            }

            @Override
            protected int getCurrentOuterSnapshotVersion() {
                return VERSION;
            }

            @Override
            protected NodeIdSerializer createOuterSerializerWithNestedSerializers(
                    TypeSerializer[] nestedSerializers) {
                return new NodeIdSerializer((EventId.EventIdSerializer) nestedSerializers[0]);
            }

            @Override
            protected TypeSerializer[] getNestedSerializers(NodeIdSerializer outerSerializer) {
                return new TypeSerializer[] {outerSerializer.eventIdSerializer};
            }
        }

        // ------------------------------------------------------------------------

        private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
            in.defaultReadObject();

            if (eventIdSerializer == null) {
                // the nested serializer will be null if this was read from a savepoint taken with
                // versions
                // lower than Flink 1.7; in this case, we explicitly create instance for the nested
                // serializer.
                this.eventIdSerializer = EventId.EventIdSerializer.INSTANCE;
            }
        }
    }
}