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 ADD_GROUP_TAG_NAME = "group";
029    
030    /** Default tag name for items */
031    public static final String ADD_ITEM_TAG_NAME = "item";
032
033    /** Default attribute name for items' references */
034    public static final String ITEM_REFERENCE_ATTRIBUTE_NAME = "ref";
035    
036    /** Tag name for references to delete items */
037    public static final String REMOVE_ITEM_TAG_NAME = "remove-item";
038    
039    /** The name of item reference to add all items */
040    public static final String ALL_ITEMS_REFERENCE = "*";
041    
042    /**
043     * Parses a view configuration to create a {@link View} object.
044     * @param viewConfiguration the configuration of the view to parse
045     * @return the view
046     * @throws ConfigurationException if the configuration is not valid.
047     */
048    public View parseView(ConfigurationAndPluginName viewConfiguration) throws ConfigurationException;
049    
050    /**
051     * Parses a view configuration to override a {@link View} object.
052     * @param viewConfiguration the configuration of the view to parse
053     * @param existingView The view to override
054     * @return the overridden view
055     * @throws ConfigurationException if the configuration is not valid.
056     */
057    public View overrideView(ConfigurationAndPluginName viewConfiguration, View existingView) throws ConfigurationException;
058}