org.ogema.persistence.DBConstants 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.persistence;

import org.ogema.core.model.Resource;
import org.ogema.core.model.ResourceList;
import org.ogema.core.model.ValueResource;
import org.ogema.core.model.array.BooleanArrayResource;
import org.ogema.core.model.array.ByteArrayResource;
import org.ogema.core.model.array.FloatArrayResource;
import org.ogema.core.model.array.IntegerArrayResource;
import org.ogema.core.model.array.StringArrayResource;
import org.ogema.core.model.array.TimeArrayResource;
import org.ogema.core.model.simple.BooleanResource;
import org.ogema.core.model.simple.FloatResource;
import org.ogema.core.model.simple.IntegerResource;
import org.ogema.core.model.simple.StringResource;
import org.ogema.core.model.simple.TimeResource;

/**
 * This class contains the definition of some constant data which is used by the ResourceDB implementation.
 * 
 * @author mns
 * 
 */
@SuppressWarnings({"unchecked", "deprecation"})
public class DBConstants {

	/*
	 * Resource status flags which are to be stored persistently
	 */
	public static final int RES_VOLATILE = 1;
	public static final int RES_NONPERSISTENT = 1 << 1;
	public static final int RES_COMPLEX_ARRAY = 1 << 2;
	public static final int RES_ACTIVE = 1 << 3;
	public static final int RES_TOPLEVEL = 1 << 4;
	public static final int RES_DECORATOR = 1 << 5;
	public static final int RES_REFERENCE = 1 << 6;
	public static final int RES_ISCHILD = 1 << 7;

	/*
	 * Type keys to be stored persistently in order to parse values properly. Only basic types have different type keys
	 * where all complex types have the same type key.
	 */
	public static final int TYPE_KEY_BOOLEAN = 0;
	public static final int TYPE_KEY_FLOAT = 1;
	public static final int TYPE_KEY_INT = 2;
	public static final int TYPE_KEY_LONG = 3;
	public static final int TYPE_KEY_STRING = 4;
	public static final int TYPE_KEY_BOOLEAN_ARR = 5;
	public static final int TYPE_KEY_FLOAT_ARR = 6;
	public static final int TYPE_KEY_INT_ARR = 7;
	public static final int TYPE_KEY_LONG_ARR = 8;
	public static final int TYPE_KEY_STRING_ARR = 9;
	public static final int TYPE_KEY_COMPLEX_ARR = 10;
	public static final int TYPE_KEY_COMPLEX = 11;
	public static final int TYPE_KEY_OPAQUE = 12;
	public static final int NONSPECIFIC_VALUE = 15;
	public static final int TYPE_KEY_INVALID = -1;

	/*
	 * Default path and file name informations for the archives containing the persistent data. The default values can
	 * be overwritten be setting of the properties DB_PATH_PROP RESOURCES_FILE_PROP DIR_FILE_PROP.
	 */
	public static final String DB_PATH_NAME = "./data/persistence/";
	public static final String RESOURCES_ARCHIVE_NAME = "resData";
	public static final String DIR_FILE_NAME = "resMap";

	/*
	 * Properties which can be set in the command line to control DB configuration.
	 */
	public static final String DB_PATH_PROP = "org.ogema.persistence.dbpath";
	public static final String RESOURCES_FILE_PROP = "org.ogema.persistence.resources";
	public static final String DIR_FILE_PROP = "org.ogema.persistence.dirmap";

	public static final String PROP_PERSISTENCE_IMPL_CLASS = "org.ogema.persistence.impl";
	public static final String PROP_NAME_PERSISTENCE_ACTIVE = "org.ogema.persistence";
	public static final String PROP_VALUE_PERSISTENCE_ACTIVE = "active";
	public static final String PROP_VALUE_PERSISTENCE_INACTIVE = "inactive";

	public static final String PROP_NAME_PERSISTENCE_DEBUG = "org.ogema.persistence.debug";
	public static final String PROP_NAME_PERSISTENCE_COMPACTION_START_SIZE = "org.ogema.persistence.compaction.start.size.file";
	public static final String PROP_NAME_PERSISTENCE_COMPACTION_START_SIZE_GARBAGE = "org.ogema.persistence.compaction.start.size.garbage";
	public static final String PROP_NAME_TIMEDPERSISTENCE_PERIOD = "org.ogema.timedpersistence.period";

	/*
	 * A constant value which indicates, that a node haven't yet a valid id.
	 */
	public static final int INVALID_ID = -1;

	/*
	 * The delimiter character in the path information of resources.
	 */
	public static final char RESOURCE_PATH_DELIMITER = '/';
	public static final String PATH_SEPARATOR = "/";

	/*
	 * Class references of known basic resources to be cached for more efficient access.
	 */
	public static final Class CLASS_SIMPLE_TYPE;
	public static final Class CLASS_BASIC_TYPE;
	public static final Class CLASS_BOOL_TYPE;
	public static final Class CLASS_FLOAT_TYPE;
	public static final Class CLASS_INT_TYPE;
	public static final Class CLASS_TIME_TYPE;
	public static final Class CLASS_STRING_TYPE;
	public static final Class CLASS_OPAQUE_TYPE;
	public static final Class CLASS_BOOL_ARR_TYPE;
	public static final Class CLASS_BYTE_ARR_TYPE;
	public static final Class CLASS_FLOAT_ARR_TYPE;
	public static final Class CLASS_INT_ARR_TYPE;
	public static final Class CLASS_TIME_ARR_TYPE;
	public static final Class CLASS_STRING_ARR_TYPE;
	@SuppressWarnings("rawtypes")
	public static final Class CLASS_COMPLEX_ARR_TYPE;

	public static String CLASS_COMPLEX_ARR_NAME = "org.ogema.core.model.ResourceList";

	public static final Class CLASS_BOOL_VALUE;
	public static final Class CLASS_INT_VALUE;
	public static final Class CLASS_FLOAT_VALUE;
	public static final Class CLASS_LONG_VALUE;
	public static final Class CLASS_OPAQUE_VALUE;
	public static final Class CLASS_STRING_VALUE;
	public static final Class CLASS_BOOL_ARR_VALUE;
	public static final Class CLASS_INT_ARR_VALUE;
	public static final Class CLASS_FLOAT_ARR_VALUE;
	public static final Class CLASS_STRING_ARR_VALUE;
	public static final Class CLASS_VALUE_RESOURCE;

	static {
		try {
			CLASS_SIMPLE_TYPE = org.ogema.core.model.SimpleResource.class;
			CLASS_BASIC_TYPE = org.ogema.core.model.Resource.class;
			CLASS_BOOL_TYPE = org.ogema.core.model.simple.BooleanResource.class;
			CLASS_FLOAT_TYPE = org.ogema.core.model.simple.FloatResource.class;
			CLASS_INT_TYPE = org.ogema.core.model.simple.IntegerResource.class;
			CLASS_STRING_TYPE = org.ogema.core.model.simple.StringResource.class;
			CLASS_OPAQUE_TYPE = org.ogema.core.model.simple.OpaqueResource.class;
			CLASS_BOOL_ARR_TYPE = org.ogema.core.model.array.BooleanArrayResource.class;
			CLASS_BYTE_ARR_TYPE = org.ogema.core.model.array.ByteArrayResource.class;
			CLASS_FLOAT_ARR_TYPE = org.ogema.core.model.array.FloatArrayResource.class;
			CLASS_INT_ARR_TYPE = org.ogema.core.model.array.IntegerArrayResource.class;
			CLASS_STRING_ARR_TYPE = org.ogema.core.model.array.StringArrayResource.class;
			CLASS_COMPLEX_ARR_TYPE = org.ogema.core.model.ResourceList.class;
			CLASS_TIME_TYPE = org.ogema.core.model.simple.TimeResource.class;
			CLASS_TIME_ARR_TYPE = org.ogema.core.model.array.TimeArrayResource.class;
			CLASS_BOOL_VALUE = java.lang.Boolean.class;
			CLASS_INT_VALUE = java.lang.Integer.class;
			CLASS_LONG_VALUE = java.lang.Long.class;
			CLASS_FLOAT_VALUE = java.lang.Float.class;
			CLASS_STRING_VALUE = java.lang.String.class;
			CLASS_OPAQUE_VALUE = (Class) Class.forName("[B");
			CLASS_BOOL_ARR_VALUE = (Class) Class.forName("[Z");
			CLASS_INT_ARR_VALUE = (Class) Class.forName("[I");
			CLASS_FLOAT_ARR_VALUE = (Class) Class.forName("[F");
			CLASS_STRING_ARR_VALUE = (Class) Class.forName("[Ljava.lang.String;");
			CLASS_VALUE_RESOURCE = ValueResource.class;
		} catch (ClassNotFoundException e)

		{
			throw new RuntimeException(e);
		}
	}
}