Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Supporting inheritance for query factory #226

Closed
wants to merge 7 commits into from
Closed

Supporting inheritance for query factory #226

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
dd77827
Supporting inheritance for query factory
tahsinz May 21, 2019
6e5e9ce
Default Sorting considering invalid field and shield
tahsinz May 21, 2019
1e3e94f
Cleaned up the code based on pull request feedback.
tahsinz May 22, 2019
4cd8606
Update fflib_SObjectSelector.cls
tahsinz May 23, 2019
5f56c3e
Update fflib_SObjectSelector.cls
tahsinz May 23, 2019
d1e2ca5
Merge branch 'patch-3' into patch-2
tahsinz Jun 4, 2019
f8e7d90
Incorporated onBeforeSOQL method so the extension can override to inc…
tahsinz Jun 4, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 24 additions & 24 deletions fflib/src/classes/fflib_QueryFactory.cls
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,39 +52,39 @@
* There is a google doc providing additional guideance on the use of this class with field sets at
* https://docs.google.com/a/financialforce.com/document/d/1I4cxN4xHT4UJj_3Oi0YBL_MJ5chm-KG8kMN1D1un8-g/edit?usp=sharing
**/
public class fflib_QueryFactory { //No explicit sharing declaration - inherit from caller
public virtual class fflib_QueryFactory { //No explicit sharing declaration - inherit from caller
public enum SortOrder {ASCENDING, DESCENDING}

/**
* This property is read-only and may not be set after instantiation.
* The {@link Schema.SObjectType} token of the SObject that will be used in the FROM clause of the resultant query.
**/
public Schema.SObjectType table {get; private set;}
public Schema.SObjectType table {get; protected set;}
@testVisible
private Set<String> fields;
private String conditionExpression;
private Integer limitCount;
private Integer offsetCount;
private List<Ordering> order;
protected Set<String> fields;
protected String conditionExpression;
protected Integer limitCount;
protected Integer offsetCount;
protected List<Ordering> order;
/**
* Integrate checking for READ Field Level Security within the selectField(s) methods
* This can optionally be enforced (or not) by calling the setEnforceFLS method prior to calling
* one of the selectField or selectFieldset methods.
**/
private Boolean enforceFLS;
protected Boolean enforceFLS;

private Boolean sortSelectFields = true;
protected Boolean sortSelectFields = true;

/**
* The relationship and subselectQueryMap variables are used to support subselect queries. Subselects can be added to
* a query, as long as it isn't a subselect query itself. You may have many subselects inside
* a query, but they may only be 1 level deep (no subselect inside a subselect)
* to add a subselect, call the subselectQuery method, passing in the ChildRelationship.
**/
private Schema.ChildRelationship relationship;
private Map<Schema.ChildRelationship, fflib_QueryFactory> subselectQueryMap;
protected Schema.ChildRelationship relationship;
protected Map<Schema.ChildRelationship, fflib_QueryFactory> subselectQueryMap;

private String getFieldPath(String fieldName){
protected String getFieldPath(String fieldName){
if(!fieldName.contains('.')){ //single field
Schema.SObjectField token = fflib_SObjectDescribe.getDescribe(table).getField(fieldName.toLowerCase());
if(token == null)
Expand Down Expand Up @@ -124,7 +124,7 @@ public class fflib_QueryFactory { //No explicit sharing declaration - inherit fr
}

@TestVisible
private static String getFieldTokenPath(Schema.SObjectField field){
protected static String getFieldTokenPath(Schema.SObjectField field){
if(field == null){
throw new InvalidFieldException('Invalid field: null');
}
Expand Down Expand Up @@ -162,7 +162,7 @@ public class fflib_QueryFactory { //No explicit sharing declaration - inherit fr
* You *must* call selectField(s) before {@link #toSOQL} will return a valid, runnable query.
* @param relationship the ChildRelationship to be used in the FROM Clause of the resultant Query (when set overrides value of table). This sets the value of {@link #relationship} and {@link #table}.
**/
private fflib_QueryFactory(Schema.ChildRelationship relationship){
protected fflib_QueryFactory(Schema.ChildRelationship relationship){
this(relationship.getChildSObject());
this.relationship = relationship;
}
Expand Down Expand Up @@ -437,7 +437,7 @@ public class fflib_QueryFactory { //No explicit sharing declaration - inherit fr
* @exception InvalidSubqueryRelationshipException If this method is called on a subselectQuery or with an invalid relationship
* @param relationship The ChildRelationship to be added as a subquery
**/
private fflib_QueryFactory setSubselectQuery(ChildRelationship relationship, Boolean assertIsAccessible){
protected fflib_QueryFactory setSubselectQuery(ChildRelationship relationship, Boolean assertIsAccessible){
if (this.relationship != null){
throw new InvalidSubqueryRelationshipException('Invalid call to subselectQuery. You may not add a subselect query to a subselect query.');
}
Expand Down Expand Up @@ -474,7 +474,7 @@ public class fflib_QueryFactory { //No explicit sharing declaration - inherit fr
* Get the ChildRelationship from the Table for the object type passed in.
* @param objType The object type of the child relationship to get
**/
private Schema.ChildRelationship getChildRelationship(sObjectType objType){
protected Schema.ChildRelationship getChildRelationship(sObjectType objType){
for (Schema.ChildRelationship childRow : table.getDescribe().getChildRelationships()){
//occasionally on some standard objects (Like Contact child of Contact) do not have a relationship name.
//if there is no relationship name, we cannot query on it, so throw an exception.
Expand All @@ -489,7 +489,7 @@ public class fflib_QueryFactory { //No explicit sharing declaration - inherit fr
* Get the ChildRelationship from the Table for the relationship name passed in.
* @param relationshipName The name of the object's ChildRelationship on get
**/
private Schema.ChildRelationship getChildRelationship(String relationshipName){
protected Schema.ChildRelationship getChildRelationship(String relationshipName){
for (Schema.ChildRelationship childRow : table.getDescribe().getChildRelationships()){
if (childRow.getRelationshipName() == relationshipName){
return childRow;
Expand Down Expand Up @@ -708,9 +708,9 @@ public class fflib_QueryFactory { //No explicit sharing declaration - inherit fr
}

public class Ordering{
private SortOrder direction;
private boolean nullsLast;
private String field;
protected SortOrder direction;
protected boolean nullsLast;
protected String field;

public Ordering(String sobjType, String fieldName, SortOrder direction){
this(
Expand All @@ -729,11 +729,11 @@ public class fflib_QueryFactory { //No explicit sharing declaration - inherit fr
this(fflib_QueryFactory.getFieldTokenPath(field), direction, nullsLast);
}
@testVisible
private Ordering(String field, SortOrder direction){
protected Ordering(String field, SortOrder direction){
this(field, direction, false);
}
@testVisible
private Ordering(String field, SortOrder direction, Boolean nullsLast){
protected Ordering(String field, SortOrder direction, Boolean nullsLast){
this.direction = direction;
this.field = field;
this.nullsLast = nullsLast;
Expand All @@ -752,8 +752,8 @@ public class fflib_QueryFactory { //No explicit sharing declaration - inherit fr


public class InvalidFieldException extends Exception{
private String fieldName;
private Schema.SObjectType objectType;
protected String fieldName;
protected Schema.SObjectType objectType;
public InvalidFieldException(String fieldname, Schema.SObjectType objectType){
this.objectType = objectType;
this.fieldName = fieldName;
Expand Down