VideoCompression.java

/*
	Copyright 2008-2014 Fraunhofer IGD, http://www.igd.fraunhofer.de
	Fraunhofer-Gesellschaft - Institute for Computer Graphics Research
	
	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.av.streaming;

import org.universAAL.ontology.av.AVOntology;

/**
 * Ontological enumeration of different video compression algorithms. Methods
 * included in this class are the mandatory ones for representing an ontological
 * enumeration in Java classes for uAAL.
 * 
 * @author climberg
 * @author Carsten Stockloew
 */
public class VideoCompression extends Compression {

    public static final String MY_URI = AVOntology.NAMESPACE
	    + "VideoCompression";

    public static final int RGB = 0;
    public static final int BGR = 1;
    public static final int YUV = 2;
    public static final int JPEG = 3;
    public static final int MPEG_1 = 4;

    // array with compression names
    private static final String[] names = { "rgb", "bgr", "yuv", "jpeg",
	    "mpeg1" };

    // the different compressions
    public static final VideoCompression rgb = new VideoCompression(RGB);
    public static final VideoCompression bgr = new VideoCompression(BGR);
    public static final VideoCompression yuv = new VideoCompression(YUV);
    public static final VideoCompression jpeg = new VideoCompression(JPEG);
    public static final VideoCompression mpeg1 = new VideoCompression(MPEG_1);

    /**
     * 
     * @param order
     * @return a video compression concerning to the order
     */
    public static VideoCompression getCompressionByOrder(int order) {
	switch (order) {
	case RGB:
	    return rgb;
	case BGR:
	    return bgr;
	case YUV:
	    return yuv;
	case JPEG:
	    return jpeg;
	case MPEG_1:
	    return mpeg1;
	default:
	    return null;
	}
    }

    /**
     * @param name
     * @return a video compression concerning to the name
     */
    public static final VideoCompression valueOf(String name) {
	if (name == null)
	    return null;

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

	for (int i = JPEG; i <= names.length; i++)
	    if (names[i].equals(name))
		return getCompressionByOrder(i);

	return null;
    }

    private int order;

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

    public String getClassURI() {
	return MY_URI;
    }

    public int getPropSerializationType(String propURI) {
	return PROP_SERIALIZATION_OPTIONAL;
    }

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

    public int ord() {
	return order;
    }

    public boolean setProperty(String propURI, Object o) {
	// do nothing
	return false;
    }
}