sbISQLBuilder.idl

Go to the documentation of this file.

/*
//
// BEGIN SONGBIRD GPL
//
// This file is part of the Songbird web player.
//
// Copyright(c) 2005-2008 POTI, Inc.
// http://songbirdnest.com
//
// This file may be licensed under the terms of of the
// GNU General Public License Version 2 (the "GPL").
//
// Software distributed under the License is distributed
// on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either
// express or implied. See the GPL for the specific language
// governing rights and limitations.
//
// You should have received a copy of the GPL along with this
// program. If not, go to http://www.gnu.org/licenses/gpl.html
// or write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//
// END SONGBIRD GPL
//
*/

#include "nsISupports.idl"

interface sbISQLBuilderCriterion;
interface sbISQLBuilderCriterionIn;
interface sbISQLSelectBuilder;

[scriptable, uuid(c214b05b-0aa8-4bf9-aa0f-a1b1ff646539)]
interface sbISQLBuilder : nsISupports
{
  const unsigned long MATCH_EQUALS       = 0;
  const unsigned long MATCH_NOTEQUALS    = 1;
  const unsigned long MATCH_GREATER      = 2;
  const unsigned long MATCH_GREATEREQUAL = 3;
  const unsigned long MATCH_LESS         = 4;
  const unsigned long MATCH_LESSEQUAL    = 5;
  const unsigned long MATCH_LIKE         = 6;
  const unsigned long MATCH_NOTLIKE      = 7;
  const unsigned long MATCH_MATCH        = 8;

  attribute long limit;

  attribute boolean limitIsParameter;

  attribute long offset;

  attribute boolean offsetIsParameter;

  const unsigned long JOIN_INNER      = 0;
  const unsigned long JOIN_LEFT       = 1;
  const unsigned long JOIN_LEFT_OUTER = 2;

  void addJoin(in unsigned long aJoinType,
               in AString aJoinedTableName,
               in AString aJoinedTableAlias,
               in AString aJoinedColumnName,
               in AString aJoinToTableName,
               in AString aJoinToColumnName);

  void addJoinWithIndexHint(in unsigned long aJoinType,
                            in AString aJoinedTableName,
                            in AString aJoinedTableAlias,
                            in AString aJoinedColumnName,
                            in AString aJoinToTableName,
                            in AString aJoinToColumnName,
                            in boolean aRequiresFromTableIndexHint,
                            in boolean aRequiresToTableIndexHint);

  void addSubqueryJoin(in unsigned long aJoinType,
                       in sbISQLSelectBuilder aJoinedSubquery,
                       in AString aJoinedTableAlias,
                       in AString aJoinedColumnName,
                       in AString aJoinToTableName,
                       in AString aJoinToColumnName);

  void addJoinWithCriterion(in unsigned long aJoinType,
                            in AString aJoinedTableName,
                            in AString aJoinedTableAlias,
                            in sbISQLBuilderCriterion aCriterion);

  void addSubquery(in sbISQLSelectBuilder aSubquery,
                   in AString aAlias);

  void reset();

  AString toString();
};

[scriptable, uuid(ec1c4745-a744-4335-af6f-5caafacb4249)]
interface sbISQLWhereBuilder : sbISQLBuilder
{
  void addCriterion(in sbISQLBuilderCriterion aCriterion);

  void removeCriterion(in sbISQLBuilderCriterion aCriterion);

  sbISQLBuilderCriterion createMatchCriterionString(in AString aTableName,
                                                    in AString aSrcColumnName,
                                                    in unsigned long aMatchType,
                                                    in AString aValue);

  sbISQLBuilderCriterion createMatchCriterionBetweenString(in AString aTableName,
                                                           in AString aSrcColumnName,
                                                           in AString aLeftValue,
                                                           in AString aRightValue);

  sbISQLBuilderCriterion createMatchCriterionNotBetweenString(in AString aTableName,
                                                              in AString aSrcColumnName,
                                                              in AString aLeftValue,
                                                              in AString aRightValue);

  sbISQLBuilderCriterion createMatchCriterionLong(in AString aTableName,
                                                  in AString aSrcColumnName,
                                                  in unsigned long aMatchType,
                                                  in long aValue);

  sbISQLBuilderCriterion createMatchCriterionLongLong(in AString aTableName,
                                                      in AString aSrcColumnName,
                                                      in unsigned long aMatchType,
                                                      in long long aValue);

  sbISQLBuilderCriterion createMatchCriterionNull(in AString aTableName,
                                                  in AString aSrcColumnName,
                                                  in unsigned long aMatchType);

  sbISQLBuilderCriterion createMatchCriterionTable(in AString aLeftTableName,
                                                   in AString aLeftColumnName,
                                                   in unsigned long aMatchType,
                                                   in AString aRightTableName,
                                                   in AString aRightColumnName);

  sbISQLBuilderCriterionIn createMatchCriterionIn(in AString aTableName,
                                                  in AString aSrcColumnName);

  sbISQLBuilderCriterion createMatchCriterionParameter(in AString aTableName,
                                                       in AString aSrcColumnName,
                                                       in unsigned long aMatchType);
  sbISQLBuilderCriterion createAndCriterion(in sbISQLBuilderCriterion aLeft,
                                            in sbISQLBuilderCriterion aRight);

  sbISQLBuilderCriterion createOrCriterion(in sbISQLBuilderCriterion aLeft,
                                           in sbISQLBuilderCriterion aRight);


};

[scriptable, uuid(b91ae93b-9c1e-427c-a751-5c0c19fcdbc3)]
interface sbISQLSelectBuilder : sbISQLWhereBuilder
{
  attribute AString baseTableName;

  attribute AString baseTableAlias;

  attribute boolean distinct;

  void addColumn(in AString aTableName,
                 in AString aColumnName);

  void clearColumns();

  void addOrder(in AString aTableName,
                in AString aColumnName,
                in boolean aAscending);

  void addRandomOrder();

  void addGroupBy(in AString aTableName,
                  in AString aColumnName);

};

[scriptable, uuid(8c584d54-2fa1-4965-8345-f1eda5a1e304)]
interface sbISQLInsertBuilder : sbISQLBuilder
{
  void addColumn(in AString aColumnName);

  void addValueString(in AString aValue);

  void addValueLong(in long aValue);

  void addValueNull();

  void addValueParameter();

  void addValueRaw(in AString aValue);

  attribute AString intoTableName;

  attribute sbISQLSelectBuilder select;
};

[scriptable, uuid(68991dbd-83f0-4df9-b3f6-89d0982ed491)]
interface sbISQLUpdateBuilder : sbISQLWhereBuilder
{
  attribute AString tableName;

  void addAssignmentString(in AString aColumnName,
                           in AString aValue);

  void addAssignmentParameter(in AString aColumnName);
};

[scriptable, uuid(73a18b36-2eee-429e-9cda-1f4428c3afb5)]
interface sbISQLDeleteBuilder : sbISQLWhereBuilder
{
  attribute AString tableName;
};

[scriptable, uuid(442c1d9d-4e8e-4aa1-9124-2f700b625a45)]
interface sbISQLBuilderCriterion : nsISupports
{
  [noscript] AString toString();
};

[scriptable, uuid(51992f09-7b9a-4a91-b708-b4551c25acf9)]
interface sbISQLBuilderCriterionIn : sbISQLBuilderCriterion
{
  void addString(in AString aValue);

  void addLong(in long aValue);

  void addSubquery(in sbISQLSelectBuilder aSubquery);

  void clear();
};