samoa-api/src/main/java/org/apache/samoa/topology/AbstractTopology.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.topology;

import java.util.HashSet;
import java.util.Set;

/**
 * Topology abstract class.
 * 
 * It manages basic information of a topology: name, sets of Streams and ProcessingItems
 * 
 */
public abstract class AbstractTopology implements Topology {

  private String topoName;
  private Set<Stream> streams;
  private Set<IProcessingItem> processingItems;
  private Set<EntranceProcessingItem> entranceProcessingItems;

  protected AbstractTopology(String name) {
    this.topoName = name;
    this.streams = new HashSet<>();
    this.processingItems = new HashSet<>();
    this.entranceProcessingItems = new HashSet<>();
  }

  /**
   * Gets the name of this topology
   * 
   * @return name of the topology
   */
  public String getTopologyName() {
    return this.topoName;
  }

  /**
   * Sets the name of this topology
   * 
   * @param topologyName
   *          name of the topology
   */
  public void setTopologyName(String topologyName) {
    this.topoName = topologyName;
  }

  /**
   * Adds an Entrance processing item to the topology.
   * 
   * @param epi
   *          Entrance processing item
   */
  public void addEntranceProcessingItem(EntranceProcessingItem epi) {
    this.entranceProcessingItems.add(epi);
    this.addProcessingItem(epi);
  }

  /**
   * Gets entrance processing items in the topology
   * 
   * @return the set of processing items
   */
  public Set<EntranceProcessingItem> getEntranceProcessingItems() {
    return this.entranceProcessingItems;
  }

  /**
   * Add processing item to topology.
   * 
   * @param procItem
   *          Processing item.
   */
  public void addProcessingItem(IProcessingItem procItem) {
    addProcessingItem(procItem, 1);
  }

  /**
   * Add processing item to topology.
   * 
   * @param procItem
   *          Processing item.
   * @param parallelismHint
   *          Processing item parallelism level.
   */
  public void addProcessingItem(IProcessingItem procItem, int parallelismHint) {
    this.processingItems.add(procItem);
  }

  /**
   * Gets processing items in the topology (including entrance processing items)
   * 
   * @return the set of processing items
   */
  public Set<IProcessingItem> getProcessingItems() {
    return this.processingItems;
  }

  /**
   * Add stream to topology.
   * 
   * @param stream
   */
  public void addStream(Stream stream) {
    this.streams.add(stream);
  }

  /**
   * Gets streams in the topology
   * 
   * @return the set of streams
   */
  public Set<Stream> getStreams() {
    return this.streams;
  }
}