SwitchSensorEvent.java

/*
     Copyright 2010-2014 AIT Austrian Institute of Technology GmbH
	 http://www.ait.ac.at
     
     See the NOTICE file distributed with this work for additional
     information regarding copyright ownership

     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.universAAL.ontology.activityhub;

import org.universAAL.ontology.ActivityHubOntology;

/**
 * Ontological enumeration of switch sensor events according to ISO 11073 - Part
 * 10471 (Independent living activity hub). Methods included in this class are
 * the mandatory ones for representing an ontological concept in Java classes
 * for uAAL. Usually it includes getters and setters for most of its properties.
 * 
 * Specific sensor events (from standard specification): - switch on - switch
 * off - no condition detected (optional)
 * 
 * @author Thomas Fuxreiter
 * 
 */
public class SwitchSensorEvent extends ActivityHubSensorEvent {
    public static final String MY_URI = ActivityHubOntology.NAMESPACE
	    + "SwitchSensorEvent";

    public static final int SWITCH_ON = 0;
    public static final int SWITCH_OFF = 1;
    public static final int NO_CONDITION_DETECTED = 2;

    private static final String[] names = { "switch_on", "switch_off",
	    "no_condition_detected" };

    public static final SwitchSensorEvent switch_on = new SwitchSensorEvent(
	    SWITCH_ON);
    public static final SwitchSensorEvent switch_off = new SwitchSensorEvent(
	    SWITCH_OFF);
    public static final SwitchSensorEvent no_condition_detected = new SwitchSensorEvent(
	    NO_CONDITION_DETECTED);

    private int order = 0;

    public SwitchSensorEvent(String uri) {
	super(uri);
    }

    private SwitchSensorEvent(int order) {
	super(ActivityHubOntology.NAMESPACE + names[order]);
	this.order = order;
    }

    public static SwitchSensorEvent getEventByOrder(int order) {
	switch (order) {
	case SWITCH_ON:
	    return switch_on;
	case SWITCH_OFF:
	    return switch_off;
	case NO_CONDITION_DETECTED:
	    return no_condition_detected;
	default:
	    return null;
	}
    }

    public static final SwitchSensorEvent valueOf(String name) {
	if (name == null)
	    return null;

	if (name.startsWith(ActivityHubOntology.NAMESPACE))
	    name = name.substring(ActivityHubOntology.NAMESPACE.length());

	for (int i = SWITCH_ON; i <= NO_CONDITION_DETECTED; i++)
	    if (names[i].equals(name))
		return getEventByOrder(i);

	return null;
    }

    public String getClassURI() {
	return MY_URI;
    }

    public int getPropSerializationType(String arg0) {
	/* This class has no property */
	return PROP_SERIALIZATION_OPTIONAL;
    }

    public boolean isWellFormed() {
	return true;
    }

    public String name() {
	return names[order];
    }

    public int ord() {
	return order;
    }
}