org.ogema.resourcetree.SimpleResourceData Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of internal-api Show documentation
Internal API of the OGEMA 2.0 reference implementation by Fraunhofer Society.
The newest version!
/**
 * Copyright 2011-2018 Fraunhofer-Gesellschaft zur Förderung der angewandten Wissenschaften e.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.ogema.resourcetree;

/**
 * Each node of a simple resource in resource tree owns an instance of SimpleResourceData that holds the value(s) of the
 * resource. SimpleResourceData instance can be obtained by calling {@link TreeElement#getData()}. Note that the right
 * method to be called depends on the type of the simple resource. A call to a method that doesn't match the type of the
 * simple resource causes an {@link UnsupportedOperationException}. For example if the simple resource has the type
 * BooleanResource the setter/getter getBoolean()/setBoolean() are to be called. Calls to all other getter/setter cause
 * the {@link UnsupportedOperationException}.
 * 
 */
public interface SimpleResourceData {

	// TODO make an enum and change the references to DBConstants in the reference implementation
	static final public int TYPE_KEY_BOOLEAN = 0;
	static final public int TYPE_KEY_FLOAT = 1;
	static final public int TYPE_KEY_INT = 2;
	static final public int TYPE_KEY_LONG = 3;
	static final public int TYPE_KEY_STRING = 4;
	static final public int TYPE_KEY_BOOLEAN_ARR = 5;
	static final public int TYPE_KEY_FLOAT_ARR = 6;
	static final public int TYPE_KEY_INT_ARR = 7;
	static final public int TYPE_KEY_LONG_ARR = 8;
	static final public int TYPE_KEY_STRING_ARR = 9;
	static final public int TYPE_KEY_COMPLEX_ARR = 10;
	static final public int TYPE_KEY_COMPLEX = 11;
	static final public int TYPE_KEY_OPAQUE = 12;

	/**
	 * Gets the boolean value.
	 * 
	 * @return The boolean value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type BooleanResource
	 */
	public boolean getBoolean() throws UnsupportedOperationException;

	/**
	 * Sets the boolean value.
	 * 
	 * @param z
	 *            boolean value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type BooleanResource
	 */
	public void setBoolean(boolean z) throws UnsupportedOperationException;

	/**
	 * Gets the float value.
	 * 
	 * @return The float value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type FloatResource
	 */
	public float getFloat() throws UnsupportedOperationException;

	/**
	 * Sets the Float value.
	 * 
	 * @param f
	 *            Float value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type FloatResource
	 */
	public void setFloat(float f) throws UnsupportedOperationException;

	/**
	 * Gets the integer value.
	 * 
	 * @return The integer value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type IntegerResource
	 */
	public int getInt() throws UnsupportedOperationException;

	/**
	 * Sets the Integer value.
	 * 
	 * @param i
	 *            Integer value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type IntegerResource
	 */
	public void setInt(int i) throws UnsupportedOperationException;

	/**
	 * Gets the Long value.
	 * 
	 * @return The Long value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type LongResource
	 */
	public long getLong() throws UnsupportedOperationException;

	/**
	 * Sets the Long value.
	 * 
	 * @param j
	 *            Long value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type LongResource
	 */
	public void setLong(long j) throws UnsupportedOperationException;

	/**
	 * Gets the String value.
	 * 
	 * @return The String value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type StringResource
	 */
	public String getString() throws UnsupportedOperationException;

	/**
	 * Sets the String value.
	 * 
	 * @param s
	 *            String value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type StringResource
	 */
	public void setString(String s) throws UnsupportedOperationException;

	/**
	 * Gets the boolean array value.
	 * 
	 * @return The boolean array value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type BooleanArrayResource
	 */
	public boolean[] getBooleanArr() throws UnsupportedOperationException;

	/**
	 * Sets the boolean array value.
	 * 
	 * @param aZ
	 *            boolean array value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type BooleanArrayResource
	 */
	public void setBooleanArr(boolean[] aZ) throws UnsupportedOperationException;

	/**
	 * Gets the Float array value.
	 * 
	 * @return The Float array value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type FloatArrayResource
	 */
	public float[] getFloatArr() throws UnsupportedOperationException;

	/**
	 * Sets the Float array value.
	 * 
	 * @param aF
	 *            Float array value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type FloatArrayResource
	 */
	public void setFloatArr(float[] aF) throws UnsupportedOperationException;

	/**
	 * Gets the Integer array value.
	 * 
	 * @return The Integer array value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type IntegerArrayResource
	 */
	public int[] getIntArr() throws UnsupportedOperationException;

	/**
	 * Sets the Integer array value.
	 * 
	 * @param aI
	 *            Integer array value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type IntegerArrayResource
	 */
	public void setIntArr(int[] aI) throws UnsupportedOperationException;

	/**
	 * Gets the Long array value.
	 * 
	 * @return The Long array value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type LongArrayResource
	 */
	public long[] getLongArr() throws UnsupportedOperationException;

	/**
	 * Sets the Long array value.
	 * 
	 * @param aJ
	 *            Long array value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type LongArrayResource
	 */
	public void setLongArr(long[] aJ) throws UnsupportedOperationException;

	/**
	 * Gets the String array value.
	 * 
	 * @return The String array value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type StringArrayResource
	 */
	public String[] getStringArr() throws UnsupportedOperationException;

	/**
	 * Sets the String array value.
	 * 
	 * @param aS
	 *            String array value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type StringArrayResource
	 */
	public void setStringArr(String[] aS) throws UnsupportedOperationException;

	/**
	 * Gets the byte array value.
	 * 
	 * @return The byte array value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type OpaqueResource
	 */
	public byte[] getByteArr() throws UnsupportedOperationException;

	/**
	 * Sets the byte array value.
	 * 
	 * @param aB
	 *            byte array value.
	 * @throws UnsupportedOperationException
	 *             If the resource is not from type OpaqueResource
	 */
	public void setByteArr(byte[] aB) throws UnsupportedOperationException;

	/**
	 * Gets the length of the underlying array if this resource is an instance of a simple array resource.
	 * 
	 * @return Length of the array or 0 if the array is not yet initialized.
	 * @throws UnsupportedOperationException
	 *             When the resource is not an instance of a simple array resource.
	 */
	public int getArrayLength() throws UnsupportedOperationException;
}