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.ConfigurationException;
019
020import org.ametys.runtime.model.ModelHelper.ConfigurationAndPluginName;
021
022/**
023 * Interface for components that parse view's configuration
024 */
025public interface ViewParser
026{
027    /** Default tag name for simple groups */
028    public static final String DEFAULT_GROUP_TAG_NAME = "group";
029    
030    /** Default tag name for item references */
031    public static final String DEFAULT_ITEM_REF_TAG_NAME = "item-ref";
032    
033    /** The name of item reference to add all items */
034    public static final String ALL_ITEMS_REFERENCE = "*";
035    
036    /**
037     * Parses a view configuration to create a {@link View} object.
038     * @param viewConfiguration the configuration of the view to parse
039     * @return the view
040     * @throws ConfigurationException if the configuration is not valid.
041     */
042    public View parseView(ConfigurationAndPluginName viewConfiguration) throws ConfigurationException;
043    
044    /**
045     * Parses a view configuration to override a {@link View} object.
046     * @param viewConfiguration the configuration of the view to parse
047     * @param existingView The view to override
048     * @return the overridden view
049     * @throws ConfigurationException if the configuration is not valid.
050     */
051    public View overrideView(ConfigurationAndPluginName viewConfiguration, View existingView) throws ConfigurationException;
052}