samoa-api/src/main/java/org/apache/samoa/learners/classifiers/trees/AttributeSliceEvent.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.samoa.learners.classifiers.trees;

import org.apache.samoa.core.ContentEvent;

/**
 * Attribute Slice Event represents the instances that split into parallelismHint (no. of local stats processors - LSP)
 * and send only one message per LSP for BoostVHT algorithm which contains that slice of the attributes along with required information
 * to update the class observers.
 *
 */

public class AttributeSliceEvent implements ContentEvent{
  private static final long serialVersionUID = 6752449086753238767L;
  private final long learningNodeId;
  private final int attributeStartingIndex;
  private final transient String key;
  private final boolean[] isNominalSlice;
  private final double[] attributeSlice;
  private final int classValue;
  private final double weight;

  public AttributeSliceEvent(
      long learningNodeId, int attributeStartingIndex, String key, boolean[] isNominalSlice, double[] attributeSlice,
      int classValue, double weight) {
    this.learningNodeId = learningNodeId;
    this.attributeStartingIndex = attributeStartingIndex;
    this.key = key;
    this.isNominalSlice = isNominalSlice;
    this.attributeSlice = attributeSlice;
    this.classValue = classValue;
    this.weight = weight;
  }

  public int getClassValue() {
    return classValue;
  }

  public double getWeight() {
    return weight;
  }

  public long getLearningNodeId() {
    return learningNodeId;
  }

  public int getAttributeStartingIndex() {
    return attributeStartingIndex;
  }

  public boolean[] getIsNominalSlice() {
    return isNominalSlice;
  }

  public double[] getAttributeSlice() {
    return attributeSlice;
  }

  @Override
  public String getKey() {
    return key;
  }

  @Override
  public void setKey(String key) {
  }

  @Override
  public boolean isLastEvent() { // TODO
    return false;
  }
}