core/sql/parser/StmtDDLAlterIndexHBaseOptions.h

#ifndef STMTDDLALTERINDEXHBASEOPTIONS_H
#define STMTDDLALTERINDEXHBASEOPTIONS_H
/* -*-C++-*-
 *****************************************************************************
 *
 * File:         StmtDDLAlterIndexHBaseOptions.h
 * Description:  class for Alter Table/Index <table-name> HBaseOptions(s)
 *               DDL statements
 *
 *               The methods in this class are defined either in this
 *               header file or in the source file StmtDDLAlter.cpp.
 *
 *               
 * Created:      5/5/15
 * Language:     C++
 *
 *
// @@@ START COPYRIGHT @@@
//
// 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.
//
// @@@ END COPYRIGHT @@@
 *
 *
 *****************************************************************************
 */

//
// The reader may notice a resemblance between this class and
// StmtDDLAlterTableHBaseOptions. In fact, they are identical,
// with two exceptions: 1. the name (of course), and 2. what
// class they inherit from. And the latter difference is essential,
// it turns out, because the productions in the parser cast this
// object to its parent class (sigh). If we had designed the 
// classes for the ALTER statement somewhat differently (say,
// making clauses orthogonal to the object being altered, at 
// least from a syntax tree perspective), we would not need to
// duplicate classes in the way we had to here.
//


#include "StmtDDLAlterIndex.h"

class ElemDDLHbaseOptions;  // forward reference

// -----------------------------------------------------------------------
// contents of this file
// -----------------------------------------------------------------------
class StmtDDLAlterIndexHBaseOptions;

// -----------------------------------------------------------------------
// forward references
// -----------------------------------------------------------------------
// None.

// -----------------------------------------------------------------------
// definition of class StmtDDLAlterIndexHBaseOptions
// -----------------------------------------------------------------------
class StmtDDLAlterIndexHBaseOptions : public StmtDDLAlterIndex
{

public:

  // constructor
  StmtDDLAlterIndexHBaseOptions(ElemDDLHbaseOptions *pHBaseOptions);

  // virtual destructor
  virtual ~StmtDDLAlterIndexHBaseOptions();

  // accessor
  inline       ElemDDLHbaseOptions * getHBaseOptions();
  inline const ElemDDLHbaseOptions * getHBaseOptions() const;

  // cast
  virtual StmtDDLAlterIndexHBaseOptions * castToStmtDDLAlterIndexHBaseOptions();

  // method for tracing
  virtual NATraceList getDetailInfo() const;
  virtual const NAString getText() const;

  StmtDDLAlterIndexHBaseOptions();   // DO NOT USE
  StmtDDLAlterIndexHBaseOptions(const StmtDDLAlterIndexHBaseOptions &);   // DO NOT USE
  StmtDDLAlterIndexHBaseOptions & operator=(const StmtDDLAlterIndexHBaseOptions &);  // DO NOT USE

private:

  // ---------------------------------------------------------------------
  // private methods
  // ---------------------------------------------------------------------

  void setHBaseOptions(ElemDDLHbaseOptions *pHBaseOptions);

        // Copies the information in the specified HBase
        // Options clause (pointed to by pHBaseOptions)
        // to data member HBaseOptions_ in this object.
        // 
        // This method can only be invoked during the
        // construction of this object when the HBase Options
        // clause appears.

  // ---------------------------------------------------------------------
  // private data members
  // ---------------------------------------------------------------------

  ElemDDLHbaseOptions * pHBaseOptions_;

}; // class StmtDDLAlterIndexHBaseOptions

// -----------------------------------------------------------------------
// definitions of inline methods for class StmtDDLAlterIndexHBaseOptions
// -----------------------------------------------------------------------

//
// accessors
//

inline const ElemDDLHbaseOptions *
StmtDDLAlterIndexHBaseOptions::getHBaseOptions() const
{
  return pHBaseOptions_;
}

inline ElemDDLHbaseOptions *
StmtDDLAlterIndexHBaseOptions::getHBaseOptions()
{
  return pHBaseOptions_;
}

#endif // STMTDDLALTERINDEXHBASEOPTIONS_H