3.1.3.2. Create a Search Function¶

3.1.3.2.1. Search the project information¶

Create a form

Create a form to accept the value submitted by the client.

ProjectSearchForm.java

public class ProjectSearchForm implements Serializable {

    /** Customer ID */
    @Domain("id")
    private String clientId;

    /** Project name */
    @Domain("projectName")
    private String projectName;

    // Getter and setter are omitted
}

Key points of this implementation

• All properties are declared as String type. For more information, see how to set validation rules .

Create a bean that holds the search condition

Create a bean to hold the search condition.

ProjectSearchDto.java

public class ProjectSearchDto implements Serializable {

    /** Customer ID */
    private Integer clientId;

    /** Project name */
    private String projectName;

    // Getter and setter are omitted

Key points of this implementation

• Bean property should be of the type that is compatible with the definition (type) of the corresponding condition column.

Create a SQL for search

Create a SQL for searching.

Project.sql

FIND_PROJECT =
SELECT
    *
FROM
    PROJECT
WHERE
    $if(clientId) {CLIENT_ID = :clientId}
    AND $if(projectName) {PROJECT_NAME LIKE :%projectName%}

Key points of this implementation

• To prevent SQL injection, SQL is written in an external file. For more information, see Manage SQL in files .
• Bind the value to SQL using the bean property name. For more information, see Execute SQL with Bean object as input.
• To include only the items specified as search condition in the conditions, build a SQL statement using the $if syntax .

Implementation of a business action method

Implement the process to search a database based on search conditions.

ProjectAction.java

@Produces(MediaType.APPLICATION_JSON)
public List<Project> find(JaxRsHttpRequest req) {

    // Convert request parameters to bean
    ProjectSearchForm form =
            BeanUtil.createAndCopy(ProjectSearchForm.class, req.getParamMap());

    // Run BeanValidation
    ValidatorUtil.validate(form);

    ProjectSearchDto searchCondition = BeanUtil.createAndCopy(ProjectSearchDto.class, form);
    return UniversalDao.findAllBySqlFile(Project.class, "FIND_PROJECT", searchCondition);
}

Key points of this implementation

• Specifies MediaType.APPLICATION_JSON in Produces annotation to return the search results in JSON format to the client.
• Acquires the query parameter from JaxRsHttpRequest .
• Creates a form from the request parameters using BeanUtil .
• Validates form using ValidatorUtil#validate.
• Copies the form value to the search condition bean using BeanUtil .
• Returns a list of project information obtained using Universal DAO, as a return value.
• As the returned object is converted to JSON format by Request Body Conversion Handler , conversion process implementation in the business action method is not required.

Define the mapping to the URL

Use Routing Adapter to map business actions and URLs. Use Path annotation for JAX-RS for mapping.

ProjectAction.java

@Path("/projects")
public class ProjectAction {
  @GET
  @Produces(MediaType.APPLICATION_JSON)
  public List<Project> find(JaxRsHttpRequest  req) {

      // Convert request parameters to beans
      ProjectSearchForm form =
              BeanUtil.createAndCopy(ProjectSearchForm.class, req.getParamMap());

      // Validate
      ValidatorUtil.validate(form);

      ProjectSearchDto searchCondition = BeanUtil.createAndCopy(ProjectSearchDto.class, form);
      return UniversalDao.findAllBySqlFile(Project.class, "FIND_PROJECT", searchCondition);
  }

Key points of this implementation

• The @Path and @GET annotations are used to define the business action methods to be mapped on GET requests.