001    /***************************************************************************************************
002     *               MODULE DESCRIPTION
003     ****************************************************************************************************
004     *
005     *               NAME:           INSERT_FILE_NAME.java
006     *               LANGUAGE:       Java2
007     *               DATE:           INSERT_DATE
008     *               AUTHOR:         INSERT_AUTHOR, University of Jyväskylä
009     *
010     ****************************************************************************************************
011     *               COPYRIGHT (C) KIURU -PROJECT GROUP
012     *               Limited rights granted. Please refer to license
013     ****************************************************************************************************
014     *  
015     ****************************************************************************************************
016     *               UPDATES
017     ****************************************************************************************************
018     *
019     *   INSERT_DATE: Initial release / INSERT_AUTHOR
020     *
021     ****************************************************************************************************/
022    package kiurubeans;
023    
024    /**
025     * Order scheme for fields that cannot order itself. Another field is
026     * provided instead.
027     * @see Field
028     */
029    public class HiddenFieldOrderScheme implements OrderScheme {
030      // Attributes
031      private String hiddenFieldName = null;
032      
033      // Constructors
034      
035      /**
036       * Initializes OrderScheme
037       * @param hiddenFieldName hidden field that is used with ordering
038       */
039      public HiddenFieldOrderScheme(String hiddenFieldName) {
040        this.hiddenFieldName = hiddenFieldName;
041      }
042      
043    // Access methods
044    
045      /** Sets fieldName. Depending of scheme type may be actual name or alias.
046       * @param fieldName new fieldName
047       */  
048      public void setFieldName(String fieldName) {}
049    
050      /** Returns FieldName
051       * @return Returns current fieldName
052       */  
053      public String getFieldName() { return ""; }
054      
055      // Operations
056      /** Returns sql clause suitable in <code>order by</code>-clause
057       * @return String that suits in <code>order by</code>-clause
058       */  
059      public String getOrder() {
060        return " "+this.hiddenFieldName+" ";
061      }
062    }
063    /***************************************************************************************************
064     *               COPYRIGHT (C) KIURU -PROJECT GROUP
065     *               Limited rights granted. Please refer to license.
066     **************************************************************************************************/