| /* |
| * 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.rya.streams.api.queries; |
| |
| import static java.util.Objects.requireNonNull; |
| |
| import java.io.Serializable; |
| import java.util.Objects; |
| import java.util.UUID; |
| |
| import com.google.common.base.Optional; |
| |
| import edu.umd.cs.findbugs.annotations.DefaultAnnotation; |
| import edu.umd.cs.findbugs.annotations.NonNull; |
| |
| /** |
| * Represents a SPARQL query specific change within Rya Streams. |
| * </p> |
| * Immutable. |
| */ |
| @DefaultAnnotation(NonNull.class) |
| public final class QueryChange implements Serializable { |
| private static final long serialVersionUID = 1L; |
| private final UUID queryId; |
| private final ChangeType changeType; |
| private final Optional<String> sparql; |
| |
| /** |
| * Constructs an instance of {@link QueryChange}. Use the {@link #create(UUID, String)} or {@link #delete(UUID)} |
| * factory methods instead. |
| * |
| * @param queryId - Uniquely identifies the query within Rya Streams. (not null) |
| * @param changeType - Indicates the type of change this object represents. (not null) |
| * @param sparql - If this is a create change, then the SPARQL query that will be evaluated within Rya Streams. (not null) |
| */ |
| private QueryChange( |
| final UUID queryId, |
| final ChangeType changeType, |
| final Optional<String> sparql) { |
| this.queryId = requireNonNull(queryId); |
| this.changeType = requireNonNull(changeType); |
| this.sparql = requireNonNull(sparql); |
| } |
| |
| /** |
| * @return Uniquely identifies the query within Rya Streams. |
| */ |
| public UUID getQueryId() { |
| return queryId; |
| } |
| |
| /** |
| * @return Indicates the type of change this object represents. |
| */ |
| public ChangeType getChangeType() { |
| return changeType; |
| } |
| |
| /** |
| * @return If this is a create change, then the SPARQL query that will be evaluated within Rya Streams. |
| */ |
| public Optional<String> getSparql() { |
| return sparql; |
| } |
| |
| @Override |
| public int hashCode() { |
| return Objects.hash(queryId, changeType, sparql); |
| } |
| |
| @Override |
| public boolean equals(final Object o) { |
| if(o instanceof QueryChange) { |
| final QueryChange change = (QueryChange) o; |
| return Objects.equals(queryId, change.queryId) && |
| Objects.equals(changeType, change.changeType) && |
| Objects.equals(sparql, change.sparql); |
| } |
| return false; |
| } |
| |
| /** |
| * Create a {@link QueryChange} that represents a new SPARQL query that will be managed by Rya Streams. |
| * |
| * @param queryId - Uniquely identifies the query within the streaming system. (not null) |
| * @param sparql - The query that will be evaluated. (not null) |
| * @return A {@link QueryChange} built using the provided values. |
| */ |
| public static QueryChange create(final UUID queryId, final String sparql) { |
| return new QueryChange(queryId, ChangeType.CREATE, Optional.of(sparql)); |
| } |
| |
| /** |
| * Create a {@link QueryChange} that represents a SPARQL query that will not longer be managed by Rya Streams. |
| * |
| * @param queryId - Identifies which query that will not longer be processed. (not null) |
| * @return A {@link QueryChange} built using the provided values. |
| */ |
| public static QueryChange delete(final UUID queryId) { |
| return new QueryChange(queryId, ChangeType.DELETE, Optional.absent()); |
| } |
| |
| /** |
| * Indicates what type of change is being indicated by a {@link QueryChange} object. |
| */ |
| public static enum ChangeType { |
| /** |
| * The {@link QueryChange} indicates a SPARQL query needs to be processed by Rya Streams. |
| */ |
| CREATE, |
| |
| /** |
| * The {@link QueryChange} indicates a SPARQL query no longer needs to be processed by Rya Streams. |
| */ |
| DELETE; |
| } |
| } |