library/src/main/java/org/apache/apex/malhar/lib/dimensions/aggregator/AbstractCompositeAggregator.java

/**
 * 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.apex.malhar.lib.dimensions.aggregator;

import java.util.Set;

import org.apache.apex.malhar.lib.appdata.schemas.FieldsDescriptor;
import org.apache.apex.malhar.lib.dimensions.DimensionsConversionContext;

import com.google.common.collect.Sets;

/**
 * SimpleCompositAggregator is the aggregator which embed other aggregator
 *
 *
 *
 * @since 3.4.0
 */
public abstract class AbstractCompositeAggregator implements CompositeAggregator
{
  private static final long serialVersionUID = 661710563764433621L;

  protected String embedAggregatorName;
  protected int dimensionDescriptorID;
  protected int aggregatorID;
  protected FieldsDescriptor aggregateDescriptor;
  //protected int embedAggregatorID;
  protected Set<Integer> embedAggregatorDdIds = Sets.newHashSet();
  protected Set<String> fields = Sets.newHashSet();

  protected DimensionsConversionContext dimensionsConversionContext;

  public DimensionsConversionContext getDimensionsConversionContext()
  {
    return dimensionsConversionContext;
  }

  public void setDimensionsConversionContext(DimensionsConversionContext dimensionsConversionContext)
  {
    this.dimensionsConversionContext = dimensionsConversionContext;
  }

  public AbstractCompositeAggregator withDimensionsConversionContext(
      DimensionsConversionContext dimensionsConversionContext)
  {
    this.setDimensionsConversionContext(dimensionsConversionContext);
    return this;
  }

  public String getEmbedAggregatorName()
  {
    return embedAggregatorName;
  }

  public void setEmbedAggregatorName(String embedAggregatorName)
  {
    this.embedAggregatorName = embedAggregatorName;
  }

  @Override
  public int hashCode()
  {
    final int prime = 31;
    int result = 1;
    result = prime * result + ((dimensionsConversionContext == null) ? 0 : dimensionsConversionContext.hashCode());
//    result = prime * result + ((embedAggregator == null) ? 0 : embedAggregator.hashCode());
    result = prime * result + ((embedAggregatorName == null) ? 0 : embedAggregatorName.hashCode());
    return result;
  }


  @Override
  public int getDimensionDescriptorID()
  {
    return dimensionDescriptorID;
  }

  public void setDimensionDescriptorID(int dimensionDescriptorID)
  {
    this.dimensionDescriptorID = dimensionDescriptorID;
  }

  @Override
  public int getAggregatorID()
  {
    return aggregatorID;
  }

  public void setAggregatorID(int aggregatorID)
  {
    this.aggregatorID = aggregatorID;
  }

  @Override
  public FieldsDescriptor getAggregateDescriptor()
  {
    return aggregateDescriptor;
  }

  public void setAggregateDescriptor(FieldsDescriptor aggregateDescriptor)
  {
    this.aggregateDescriptor = aggregateDescriptor;
  }

  @Override
  public Set<String> getFields()
  {
    return fields;
  }

  public void setFields(Set<String> fields)
  {
    this.fields = fields;
  }

  @Override
  public int getSchemaID()
  {
    // TODO Auto-generated method stub
    return 0;
  }

  //implement this, the ddid in fact should be a set or list. or return the first ddid, and use the timebucket to
  //get other ddids. or think about get rid of this method in this class and implement outside. if the embeded
  //aggregator is OTF, just keep the ddid of OTF as depended incremental aggregators should have same ddid
  @Override
  public Set<Integer> getEmbedAggregatorDdIds()
  {
    return embedAggregatorDdIds;
  }

  public void addEmbedAggregatorDdId(int ddid)
  {
    embedAggregatorDdIds.add(ddid);
  }

  public void addEmbedAggregatorDdIds(Set<Integer> ddids)
  {
    embedAggregatorDdIds.addAll(ddids);
  }

  /**
   * bright: TODO: check
   */
  @Override
  public FieldsDescriptor getMetaDataDescriptor()
  {
    return null;
  }

}