Package com.jk.data.dynamic.query

Class StringReturnValue

java.lang.Object
com.jk.data.dynamic.query.StringReturnValue
All Implemented Interfaces:
QueryComponent, ReturnValue
public class StringReturnValue extends Object implements ReturnValue
This class represents a return value or selection criteria in a query expressed as a string.

It implements the ReturnValue interface.

Version:
1.0
Author:
Dr. Jalal H. Kiswani

  • Constructor Summary

    Constructors
    Constructor
    Description
    StringReturnValue(String returnValue)
    This method constructs a new StringReturnValue with a specified return value string.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getReturnValue()
    This method gets the return value.
    boolean
    isInline()
    This method determines whether the query component should be rendered in-line in the query structure (true) or not (false).
    void
    setReturnValue(String returnValue)
    This method sets the return value to the provided one.
    Object
    toQueryElement()
    This method converts the query component into a query element that can be included in the query structure.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • StringReturnValue

      public StringReturnValue(String returnValue)
      This method constructs a new StringReturnValue with a specified return value string.
      Parameters:
      returnValue - Specifies the return value string.

  • Method Details

    • getReturnValue

      public String getReturnValue()
      This method gets the return value.
      Returns:
      the return value.

    • isInline

      public boolean isInline()
      This method determines whether the query component should be rendered in-line in the query structure (true) or not (false).
      Specified by:
      isInline in interface QueryComponent
      Returns:
      true.

    • setReturnValue

      public void setReturnValue(String returnValue)
      This method sets the return value to the provided one.
      Parameters:
      returnValue - Specifies the new return value.

    • toQueryElement

      public Object toQueryElement()
      This method converts the query component into a query element that can be included in the query structure.
      Specified by:
      toQueryElement in interface QueryComponent
      Returns:
      the query element, which can be a string or any appropriate object representation.