org.openmdx.application.dataprovider.cci.AttributeSelectors Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmdx-dalvik Show documentation
openMDX/Dalvik Library
There is a newer version: 2.18.10
/*
 * ====================================================================
 * Project:     openmdx, http://www.openmdx.org/
 * Description: Generated constants for AttributeSelectors
 * Owner:       OMEX AG, Switzerland, http://www.omex.ch
 * ====================================================================
 *
 * This software is published under the BSD license
 * as listed below.
 * 
 * Copyright (c) 2004, OMEX AG, Switzerland
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or
 * without modification, are permitted provided that the following
 * conditions are met:
 * 
 * * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in
 * the documentation and/or other materials provided with the
 * distribution.
 * 
 * * Neither the name of the openMDX team nor the names of its
 * contributors may be used to endorse or promote products derived
 * from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * ------------------
 * 
 * This product includes software developed by the Apache Software
 * Foundation (http://www.apache.org/).
 */
package org.openmdx.application.dataprovider.cci;

import javax.jdo.FetchPlan;

import org.openmdx.base.exception.ServiceException;
import org.openmdx.base.rest.cci.QueryRecord;


/**
 * The AttributeSelectors class contains constants 
 * identifying the set of attributes to be retrieved.
 */




public class AttributeSelectors {

  
  protected AttributeSelectors() {
      // Avoid instantiation
  }


  /**
   * Retrieve no attributes.
   */
  static public final short NO_ATTRIBUTES = 0;



  /**
   * Retrieve specified and system attributes.
   */
  static public final short SPECIFIED_AND_SYSTEM_ATTRIBUTES = 1;



  /**
   * Retrieve specified and typical attributes.
   */
  static public final short SPECIFIED_AND_TYPICAL_ATTRIBUTES = 2;



  /**
   * Retrieve all attributes.
   */
  static public final short ALL_ATTRIBUTES = 3;



  /**
   * Returns the smallest defined integer constant or
   * Integer.MAX_VALUE if no integer constant is defined.
   *
   * @return an int
   */
  static public int min()
  {
    return NO_ATTRIBUTES;
  }



  /**
   * Returns the biggest defined integer constant or
   * Integer.MIN_VALUE if no integer constant is defined.
   *
   * @return an int
   */
  static public int max()
  {
    return ALL_ATTRIBUTES;
  }


  public static short getAttributeSelector(
      QueryRecord query
  ) throws ServiceException {
      String fetchGroup = query.getFetchGroupName();
      if(fetchGroup == null || fetchGroup.isEmpty() || FetchPlan.DEFAULT.equals(fetchGroup)) {
          return AttributeSelectors.SPECIFIED_AND_TYPICAL_ATTRIBUTES;
      } else if(FetchPlan.ALL.equals(fetchGroup)) {
          return AttributeSelectors.ALL_ATTRIBUTES;
      } else {
          return AttributeSelectors.SPECIFIED_AND_SYSTEM_ATTRIBUTES;
      }
  }

  /**
   * Returns a string representation of the passed code
   *
   * @param code  a code to be stringified
   * @return a stringified code
   */
  static public String toString(int code)
  {
    switch(code) {
      case NO_ATTRIBUTES: return "NO_ATTRIBUTES";
      case SPECIFIED_AND_SYSTEM_ATTRIBUTES: return "SPECIFIED_AND_SYSTEM_ATTRIBUTES";
      case SPECIFIED_AND_TYPICAL_ATTRIBUTES: return "SPECIFIED_AND_TYPICAL_ATTRIBUTES";
      case ALL_ATTRIBUTES: return "ALL_ATTRIBUTES";
      default:
        return String.valueOf(code);
    }
  }



  /**
   * Returns the code of the passed code's string representation.
   * The string representation is case insensitive.
   *
   * @exception  throws an IllegalArgumentException 
   *             if the stringified code cannot be resolved
   * @param code a stringified code
   * @return a code
   */
  static public int fromString(String code)
  {  
    if (code.equalsIgnoreCase("NO_ATTRIBUTES")) return NO_ATTRIBUTES;
    if (code.equalsIgnoreCase("SPECIFIED_AND_SYSTEM_ATTRIBUTES")) return SPECIFIED_AND_SYSTEM_ATTRIBUTES;
    if (code.equalsIgnoreCase("SPECIFIED_AND_TYPICAL_ATTRIBUTES")) return SPECIFIED_AND_TYPICAL_ATTRIBUTES;
    if (code.equalsIgnoreCase("ALL_ATTRIBUTES")) return ALL_ATTRIBUTES;

    // Not found
    throw new IllegalArgumentException(
          "The code '" + code + "' is unkown to the class AttributeSelectors");
  }



}

// end-of-file