solutions.siren.join.action.terms.TermsByQueryShardResponse Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2016, SIREn Solutions. All Rights Reserved.
 *
 * This file is part of the SIREn project.
 *
 * SIREn is a free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * SIREn 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
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with this program. If not, see .
 */
package solutions.siren.join.action.terms;

import org.elasticsearch.action.support.broadcast.BroadcastShardResponse;
import org.elasticsearch.cluster.ClusterState;
import org.elasticsearch.common.breaker.CircuitBreaker;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.index.shard.ShardId;
import solutions.siren.join.action.terms.collector.*;

import java.io.IOException;
import java.util.concurrent.atomic.AtomicReferenceArray;

/**
 * Internal terms by query response of a shard terms by query request executed directly against a specific shard.
 */
class TermsByQueryShardResponse extends BroadcastShardResponse {

  private TermsSet termsSet;
  private final CircuitBreaker breaker;

  /**
   * Default constructor
   */
  TermsByQueryShardResponse(final CircuitBreaker breaker) {
    this.breaker = breaker;
  }

  /**
   * Main constructor
   *
   * @param shardId the id of the shard the request executed on
   * @param termsSet the terms gathered from the shard
   */
  public TermsByQueryShardResponse(ShardId shardId, TermsSet termsSet) {
    super(shardId);
    this.termsSet = termsSet;
    this.breaker = null;
  }

  /**
   * Gets the gathered terms.
   *
   * @return the {@link TermsSet}
   */
  public TermsSet getTerms() {
    return this.termsSet;
  }

  /**
   * Deserialize
   */
  @Override
  public void readFrom(StreamInput in) throws IOException {
    super.readFrom(in);

    TermsByQueryRequest.TermsEncoding termsEncoding = TermsByQueryRequest.TermsEncoding.values()[in.readVInt()];
    switch (termsEncoding) {

      case LONG:
        termsSet = new LongTermsSet(breaker);
        termsSet.readFrom(in);
        return;

      case INTEGER:
        termsSet = new IntegerTermsSet(breaker);
        termsSet.readFrom(in);
        return;

      case BLOOM:
        termsSet = new BloomFilterTermsSet(breaker);
        termsSet.readFrom(in);
        return;

      case BYTES:
        termsSet = new BytesRefTermsSet(breaker);
        termsSet.readFrom(in);
        return;

      default:
        throw new IOException("[termsByQuery] Invalid type of terms encoding: " + termsEncoding.name());

    }
  }

  /**
   * Serialize and release the terms set.
   * 
   * If the response is sent through a {@link org.elasticsearch.transport.TransportService.DirectResponseChannel},
   * this method will not be called and the {@link #termsSet} will be released by the receiver, i.e.,
   * {@link TransportTermsByQueryAction#newResponse(TermsByQueryRequest, AtomicReferenceArray, ClusterState)}.
   */
  @Override
  public void writeTo(StreamOutput out) throws IOException {
    try {
      super.writeTo(out);
      // Encode type of encoding
      out.writeVInt(termsSet.getEncoding().ordinal());
      // Encode terms
      termsSet.writeTo(out);
    }
    finally {
      // Releases the resources and adjust the circuit breaker
      termsSet.release();
    }
  }
}