Examples of hirondelle.web4j.database.SqlId

hirondelle.web4j.database.SqlId
Identifier of an SQL statement block in an .sql file. (Such identifiers must be unique.)
This class does not contain the text of the underlying SQL statement. Rather, this class allows a code friendly way of referencing SQL statements. Since .sql files are simple text files, there is a need to build a bridge between these text files and java code. This class is that bridge.
Please see the package summary for important information regarding .sql files.
Typical use case :
```
public static final SqlId MEMBER_FETCH = new SqlId("MEMBER_FETCH");
```
This corresponds to an entry in an .sql file :
```
 MEMBER_FETCH { SELECT Id, Name, IsActive, DispositionFK  FROM Member WHERE Id=? } 
```
This class is unusual, since there is only one way to use these objects. That is, they must be declared as public static final fields in a public class. They should never be used as local objects in the body of a method. (This unusual restriction exists to allow the framework to find and examine such fields using reflection.) The text passed to the constructor must correspond to the identifier of some SQL statement block in an .sql file. Such identifiers must match a specific {@link #FORMAT}.
Startup Checks
To discover simple typographical errors as quickly as possible, the framework will run diagnostics upon startup : there must be an exact, one-to-one correspondence between the SQL statement identifiers defined in the .sql file(s), and the public static final SqlId fields declared by the application. Any mismatch will result in an error. (Running such diagnostics upon startup is highly advantageous, since the only alternative is discovery during actual use, upon the first execution of a particular operation.)
Where To Declare SqlId Fields
Where should SqlId fields be declared? The only real restriction is that they must be declared in a public class. With the most recommended first, one may declare SqlId fields in :
- a public {@link hirondelle.web4j.action.Action}
- a public Data Access Object
- a public constants class, one per package/feature.
- a public constants class, one per application. If more than one developer at a time works on the application, then this style will result in a lot of developer contention. It is not recommended.
Design Note
The justification for recommending that SqlId fields appear in a {@link hirondelle.web4j.action.Action} is as follows :
- it is highly satisfying to have mostly package-private classes in an application, since it takes advantage of a principal technique for "information hiding" - one of the guiding principles of lasting value in object programming. For instance, it is usually possible to have a Data Access Object (DAO) as package-private. If a SqlId is declared in a DAO, however, then that DAO must be changed to public, just to render the SqlId fields accessible by reflection, which is distasteful.
- the {@link hirondelle.web4j.action.Action} is always public anyway, so adding a SqlId will not change its scope.
- {@link hirondelle.web4j.action.Action} is intended as the public face of each feature. Therefore, all important items related to the feature should be documented there - what it does, when is it called, and how it shows a response. One can argue with some force that the single most important thing about a feature is "What does it do?". In a typical database application, the answer to that question is usually "these SQL operations".

  private void refreshPickLists() throws DAOException {
    Startup.lookUpCodeTablesAndPlaceIntoAppScope();
  }
  
  private static SqlId getTranslationSqlId(String aSqlStatementId){
    return new SqlId(ConnectionSrc.TRANSLATION, aSqlStatementId);
  }

View Full Code Here

    Db.edit(DELETE, aBaseTextId, aLocaleId);
  }
  
  // PRIVATE //
  private static SqlId getSqlId(String aSqlId){
    return new SqlId(ConnectionSrc.TRANSLATION, aSqlId);
  }

View Full Code Here

    }
    return result;
  }
  
  private static SqlId getSqlId(String aSqlStatementId){
    return new SqlId(ConnectionSrc.TRANSLATION, aSqlStatementId);
  }

View Full Code Here

  private BaseText fBaseText;
  private UnknownBaseTextDAO fUnknownBaseTextDAO = new UnknownBaseTextDAO();
  private static final ResponsePage FORWARD = TemplatedPage.get("Unknowns", "view.jsp", UnknownBaseTextEdit.class);
  
  private static SqlId getSqlId(String aSqlStatementId){
    return new SqlId(ConnectionSrc.TRANSLATION, aSqlStatementId);
  }

View Full Code Here

  private BaseTextDAO fBaseTextDAO = new BaseTextDAO();
  private static final ResponsePage FORWARD = TemplatedPage.get("Base Text", "view.jsp", BaseTextAction.class);
  private static final ResponsePage REDIRECT_TO_LISTING = new ResponsePage("BaseTextEdit.do?Operation=List");
  
  private static SqlId getTranslationSqlId(String aSqlStatementId){
    return new SqlId(ConnectionSrc.TRANSLATION, aSqlStatementId);
  }

View Full Code Here

TOP

Related Classes of hirondelle.web4j.database.SqlId

hirondelle.fish.translate.basetext.BaseTextAction

hirondelle.fish.translate.locale.SupportedLocaleAction

hirondelle.fish.translate.translation.TranslationDAO

hirondelle.fish.translate.translation.TranslationEdit

hirondelle.fish.translate.unknown.UnknownBaseTextEdit

java.util.regex.Pattern

hirondelle.web4j.model.ModelCtorException

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.