com.factset.protobuf.stach.extensions.RowStachExtensionBuilder Maven / Gradle / Ivy

Go to download
package com.factset.protobuf.stach.extensions;

import com.factset.protobuf.stach.v2.RowOrganizedProto;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.google.protobuf.InvalidProtocolBufferException;


public interface RowStachExtensionBuilder {

    /**
     * Sets the RowOrganizedPackage object.
     * @param pkg package object of type RowOrganizedPackage
     * @return builder instance
     */
    RowStachExtensionBuilder setPackage(RowOrganizedProto.RowOrganizedPackage pkg);

    /**
     * Sets the RowOrganizedPackage object by parsing raw object input.
     * @param pkg package object
     * @return builder instance
     * @throws JsonProcessingException
     * @throws InvalidProtocolBufferException
     */
    RowStachExtensionBuilder setPackage(Object pkg) throws JsonProcessingException, InvalidProtocolBufferException;

    /**
     * Set the RowOrganizedPackage object by parsing the input in string format.
     * @param pkgString string form of package object
     * @return builder instance
     * @throws InvalidProtocolBufferException
     */
    RowStachExtensionBuilder setPackage(String pkgString) throws InvalidProtocolBufferException;

    /**
     * Add the Row Organized Table to the package
     * @param tableId id of the table
     * @param table Row Organized Table object
     * @return Builder instance
     */
    RowStachExtensionBuilder addTable(String tableId, RowOrganizedProto.RowOrganizedPackage.Table table);

    /**
     * Add the Row Organized Table to the package
     * @param tableId id of the table
     * @param tableString Row Organized Table in string format
     * @return Builder instance
     * @throws InvalidProtocolBufferException
     */
    RowStachExtensionBuilder addTable(String tableId, String tableString) throws InvalidProtocolBufferException;

    /**
     * Add the Row Organized Table to the package
     * @param tableId id of the table
     * @param tableObject Row organized table object
     * @return Builder instance
     * @throws JsonProcessingException
     * @throws InvalidProtocolBufferException
     */
    RowStachExtensionBuilder addTable(String tableId, Object tableObject) throws JsonProcessingException, InvalidProtocolBufferException;

    /**
     * Get the Row Organized Package set for the builder.
     * @return RowOrganizedPackage instance
     */
    RowOrganizedProto.RowOrganizedPackage getPackage();


    /**
     * Builds the stach extension and returns the instance.
     * @return instance of row organized stach extension class.
     */
    StachExtensions build();
}