001/*
002 * ============================================================================
003 * Copyright © 2002-2020 by Thomas Thrien.
004 * All Rights Reserved.
005 * ============================================================================
006 * Licensed to the public under the agreements of the GNU Lesser General Public
007 * License, version 3.0 (the "License"). You may obtain a copy of the License at
008 *
009 *      http://www.gnu.org/licenses/lgpl.html
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
013 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
014 * License for the specific language governing permissions and limitations
015 * under the License.
016 */
017
018package org.tquadrat.foundation.svg.internal;
019
020import static org.apiguardian.api.API.Status.INTERNAL;
021import static org.tquadrat.foundation.svg.SVGUtils.SVGATTRIBUTE_Class;
022import static org.tquadrat.foundation.svg.SVGUtils.SVGATTRIBUTE_ExternalResourcesRequired;
023import static org.tquadrat.foundation.svg.SVGUtils.SVGATTRIBUTE_Id;
024import static org.tquadrat.foundation.svg.SVGUtils.SVGATTRIBUTE_PreserveAspectRatio;
025import static org.tquadrat.foundation.svg.SVGUtils.SVGATTRIBUTE_Style;
026import static org.tquadrat.foundation.svg.SVGUtils.SVGATTRIBUTE_ViewBox;
027import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_AltGlyphDef;
028import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_Anchor;
029import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_ClipPath;
030import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_ColorProfile;
031import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_Cursor;
032import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_Filter;
033import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_Font;
034import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_FontFace;
035import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_ForeignObject;
036import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_Image;
037import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_Marker;
038import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_Mask;
039import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_Pattern;
040import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_Script;
041import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_Style;
042import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_Switch;
043import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_Symbol;
044import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_Text;
045import static org.tquadrat.foundation.svg.SVGUtils.SVGELEMENT_View;
046import static org.tquadrat.foundation.svg.type.SVGElementCategory.ANIMATION;
047import static org.tquadrat.foundation.svg.type.SVGElementCategory.DESCRIPTIVE;
048import static org.tquadrat.foundation.svg.type.SVGElementCategory.GRADIENT;
049import static org.tquadrat.foundation.svg.type.SVGElementCategory.SHAPE;
050import static org.tquadrat.foundation.svg.type.SVGElementCategory.STRUCTURAL;
051import static org.tquadrat.foundation.xml.builder.XMLElement.Flags.ALLOWS_CHILDREN;
052import static org.tquadrat.foundation.xml.builder.XMLElement.Flags.VALIDATES_ATTRIBUTES;
053import static org.tquadrat.foundation.xml.builder.XMLElement.Flags.VALIDATES_CHILDREN;
054
055import java.util.ArrayList;
056import java.util.Collection;
057import java.util.HashSet;
058import java.util.List;
059
060import org.apiguardian.api.API;
061import org.tquadrat.foundation.annotation.ClassVersion;
062import org.tquadrat.foundation.svg.AllowsGraphicalEventAttributes;
063import org.tquadrat.foundation.svg.AllowsPresentationAttributes;
064import org.tquadrat.foundation.svg.SVGSymbol;
065
066/**
067 *  The implementation for the interface
068 *  {@link SVGSymbol}
069 *  for the {@code <symbol>} element.
070 *
071 *  @extauthor Thomas Thrien - thomas.thrien@tquadrat.org
072 *  @version $Id: SVGSymbolImpl.java 820 2020-12-29 20:34:22Z tquadrat $
073 *  @since 0.0.5
074 *
075 *  @UMLGraph.link
076 */
077@ClassVersion( sourceVersion = "$Id: SVGSymbolImpl.java 820 2020-12-29 20:34:22Z tquadrat $" )
078@API( status = INTERNAL, since = "0.0.5" )
079public final class SVGSymbolImpl extends SVGElementImpl implements SVGSymbol
080{
081        /*--------------*\
082    ====** Constructors **=====================================================
083        \*--------------*/
084    /**
085     *  Creates a new {@code SVGSymbolImpl} instance.
086     *
087     *  @param  id  The id for the new symbol.
088     */
089    public SVGSymbolImpl( final String id )
090    {
091        super( SVGELEMENT_Symbol, ALLOWS_CHILDREN, VALIDATES_ATTRIBUTES, VALIDATES_CHILDREN );
092
093        //---* The children and attributes for the <symbol> element *----------
094        final Collection<String> childElements = new HashSet<>();
095        childElements.addAll( ANIMATION.getElements() );
096        childElements.addAll( DESCRIPTIVE.getElements() );
097        childElements.addAll( SHAPE.getElements() );
098        childElements.addAll( STRUCTURAL.getElements() );
099        childElements.addAll( GRADIENT.getElements() );
100        childElements.addAll( List.of( SVGELEMENT_Anchor,
101            SVGELEMENT_AltGlyphDef, SVGELEMENT_ClipPath,
102            SVGELEMENT_ColorProfile, SVGELEMENT_Cursor, SVGELEMENT_Filter,
103            SVGELEMENT_Font, SVGELEMENT_FontFace, SVGELEMENT_ForeignObject,
104            SVGELEMENT_Image, SVGELEMENT_Marker, SVGELEMENT_Mask,
105            SVGELEMENT_Pattern, SVGELEMENT_Script, SVGELEMENT_Style,
106            SVGELEMENT_Switch, SVGELEMENT_Text, SVGELEMENT_View ) );
107
108        final Collection<String> attributes = new ArrayList<>();
109        attributes.addAll( List.of( SVGATTRIBUTE_Id,
110            SVGATTRIBUTE_PreserveAspectRatio, SVGATTRIBUTE_ViewBox,
111            SVGATTRIBUTE_Class, SVGATTRIBUTE_Style,
112            SVGATTRIBUTE_ExternalResourcesRequired ) );
113        attributes.addAll( CORE_ATTRIBUTES );
114        attributes.addAll( AllowsGraphicalEventAttributes.GRAPHICALEVENT_ATTRIBUTES );
115        attributes.addAll( AllowsPresentationAttributes.PRESENTATION_ATTRIBUTES );
116
117        updateRegistries( childElements, attributes );
118
119        setId( id );
120    }   //  SVGSymbolImpl()
121}
122//  class SVGSymbolImpl
123
124/*
125 *  End of File
126 */