001/*
002 *  Copyright 2020 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.runtime.model;
017
018import org.apache.avalon.framework.configuration.Configuration;
019import org.apache.avalon.framework.configuration.ConfigurationException;
020
021/**
022 * Interface for components that parse view's configuration
023 */
024public interface ViewParser
025{
026    /** Default tag name for simple groups */
027    public static final String DEFAULT_GROUP_TAG_NAME = "group";
028    
029    /** Default tag name for item references */
030    public static final String DEFAULT_ITEM_REF_TAG_NAME = "item-ref";
031    
032    /** The name of item reference to add all items */
033    public static final String ALL_ITEMS_REFERENCE = "*";
034    
035    /**
036     * Parses a view configuration to create a {@link View} object.
037     * @param viewConfiguration the configuration of the view to parse
038     * @return the view
039     * @throws ConfigurationException if the configuration is not valid.
040     */
041    public View parseView(Configuration viewConfiguration) throws ConfigurationException;
042}