baseten / Sources / BXPGRelationAliasMapper.h

// BXPGRelationAliasMapper.h
// BaseTen
// Copyright (C) 2006-2008 Marko Karppinen & Co. LLC.
// Before using this software, please review the available licensing options
// by visiting or by contacting
// us at Without an additional license, this software
// may be distributed only in compliance with the GNU General Public License.
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, version 2.0,
// as published by the Free Software Foundation.
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
// $Id$

#import <Foundation/Foundation.h>
#import <BaseTen/BXLogger.h>

@class BXPGFromItem;
@class BXEntityDescription;
@class BXRelationshipDescription;
@class BXPGPrimaryRelationFromItem;
@class BXPGRelationshipFromItem;
@class BXPGHelperTableRelationshipFromItem;
@class BXManyToManyRelationshipDescription;

BX_EXPORT NSArray* BXPGConditions (NSString* srcAlias, NSString* dstAlias, NSSet* fieldNamePairs);

@protocol BXPGFromItemVisitor <NSObject>
- (NSString *) visitPrimaryRelation: (BXPGPrimaryRelationFromItem *) fromItem;
- (NSString *) visitRelationshipJoinItem: (BXPGRelationshipFromItem *) fromItem;

@protocol BXPGRelationshipVisitor <NSObject>
- (NSString *) visitSimpleRelationship: (BXPGRelationshipFromItem *) fromItem;
- (NSString *) visitManyToManyRelationship: (BXPGHelperTableRelationshipFromItem *) fromItem;

@interface BXPGRelationAliasMapper : NSObject 
	BXPGPrimaryRelationFromItem* mPrimaryRelation;
	NSMutableArray* mFromItems;
	NSMutableDictionary* mUsedAliases;
	NSMutableArray* mCurrentFromItems;
	BOOL mIsFirstInUpdate;

- (BXPGPrimaryRelationFromItem *) primaryRelation;
- (void) accept;
- (void) resetCurrent;
- (void) resetAll;

- (NSString *) fromClauseForSelect;
- (NSString *) fromOrUsingClause;
- (NSString *) target;

- (NSString *) addAliasForEntity: (BXEntityDescription *) entity;
- (BXPGPrimaryRelationFromItem *) addPrimaryRelationForEntity: (BXEntityDescription *) entity;
- (BXPGRelationshipFromItem *) addFromItemForRelationship: (BXRelationshipDescription *) rel;
- (BXPGRelationshipFromItem *) previousFromItem;
- (BXPGRelationshipFromItem *) firstFromItem;

@interface BXPGRelationAliasMapper (BXPGFromItemVisitor) <BXPGFromItemVisitor>

@interface BXPGRelationAliasMapper (BXPGRelationshipVisitor) <BXPGRelationshipVisitor>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.