C24Utils.java

/*
 * Copyright 2011 the original author or authors.
 *
 * 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 biz.c24.io.spring.util;

import java.util.HashSet;
import java.util.Set;

import org.springframework.beans.BeanUtils;

import biz.c24.io.api.data.ComplexDataObject;
import biz.c24.io.api.data.DocumentRoot;
import biz.c24.io.api.data.Element;

/**
 * Utility classes to work with a C24 model.
 *
 * @author Oliver Gierke
 */
public abstract class C24Utils {

    /**
     * The default encoding C24 Spring classes will use when reading and writing files unless
     * otherwise specified
     */
    public static final String DEFAULT_FILE_ENCODING = "UTF-8";
    
	private C24Utils() {

	}

	/**
	 * Returns all the classes supported by the given model {@link Element}.
	 * 
	 * @param element
	 * @return
	 */
	@SuppressWarnings("unchecked")
	public static Set<Class<? extends ComplexDataObject>> getSupportedTypes(Element element) {

		Class<? extends ComplexDataObject> type = element.getType().getValidObjectClass();
		HashSet<Class<? extends ComplexDataObject>> result = new HashSet<Class<? extends ComplexDataObject>>();

		if (!DocumentRoot.class.isAssignableFrom(type)) {
			result.add(type);
			return result;
		}

		DocumentRoot root = (DocumentRoot) BeanUtils.instantiateClass(type);

		for (int i=0; i < root.getElementDeclCount(); i++) {
			Element declaredElement = root.getElementDecl(i);
			result.add(declaredElement.getType().getValidObjectClass());
		}

		return result;
	}

	/**
	 * Will return the given source {@link ComplexDataObject} if it's an arbitrary one or extract the root object in case
	 * the given argument is a {@link DocumentRoot}.
	 * 
	 * @param source
	 * @return
	 */
	public static ComplexDataObject potentiallyUnwrapDocumentRoot(ComplexDataObject source) {
		return source instanceof DocumentRoot ? (ComplexDataObject) ((DocumentRoot) source).getRootElement() : source;
	}
}