001/* Backwards compatibility changes for DocAttribute.
002
003 Copyright (c) 2015-2018 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026
027 */
028package ptolemy.moml.filter;
029
030import ptolemy.kernel.util.NamedObj;
031import ptolemy.moml.MoMLParser;
032
033///////////////////////////////////////////////////////////////////
034////DocAttributeChanges
035
036/**
037 * A MoML filter to convert StringParameters contained by DocAttribute to
038 * StringAttributes.
039 *
040 * @author Daniel Crawl
041 * @version $Id$
042 * @since Ptolemy II 11.0
043 * @Pt.ProposedRating Red ()
044 * @Pt.AcceptedRating Red ()
045 */
046public class DocAttributeChanges extends MoMLFilterSimple {
047
048    /** Change StringParameter attributes insinde DocAttribute to
049     *  StringAttribute.
050     *  @param container  The container for this attribute.
051     *  @param element The XML element name.
052     *  @param attributeName The name of the attribute.
053     *  @param attributeValue The value of the attribute.
054     *  @param xmlFile The file currently being parsed.
055     *  @return the value of the attributeValue argument.
056     */
057    @Override
058    public String filterAttributeValue(NamedObj container, String element,
059            String attributeName, String attributeValue, String xmlFile) {
060
061        if (container != null
062                && container.getClass().getName().equals(_docAttributeClassName)
063                && attributeName.equals("class") && attributeValue != null
064                && attributeValue.equals(_stringParameterClassName)) {
065            MoMLParser.setModified(true);
066            return _stringAttributeClassName;
067        }
068        return attributeValue;
069    }
070
071    /** In this class, do nothing. */
072    @Override
073    public void filterEndElement(NamedObj container, String elementName,
074            StringBuffer currentCharData, String xmlFile) throws Exception {
075    }
076
077    /** Class name of DocAttribute. */
078    private final static String _docAttributeClassName = "ptolemy.vergil.basic.DocAttribute";
079
080    /** Class name of StringAttribute. */
081    private final static String _stringAttributeClassName = "ptolemy.kernel.util.StringAttribute";
082
083    /** Class name of StringParameter. */
084    private final static String _stringParameterClassName = "ptolemy.data.expr.StringParameter";
085}