001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2013-2015 ForgeRock AS.
015 */
016
017package org.forgerock.doc.maven.utils;
018
019import org.forgerock.doc.maven.utils.helper.FileFilterFactory;
020
021/**
022 * Update XML files, transforming <imagedata> elements to make sure they use
023 * {@code scalefit="1"}, {@code width="100%"}, and {@code contentdepth="100%"}
024 * attributes.
025 */
026public class ImageDataTransformer extends XmlTransformer {
027
028    /**
029     * Construct an updater to match DocBook XML files.
030     *
031     * <p>
032     *
033     * The files are updated in place.
034     *
035     * <p>
036     *
037     * The following example shows how this might be used in your code.
038     *
039     * <pre>
040     *     File xmlSourceDirectory  = new File("/path/to/xml/files/");
041     *
042     *     // Update XML files.
043     *     ImageDataTransformer idt = new ImageDataTransformer();
044     *     return idt.update(xmlSourceDirectory);
045     * </pre>
046     */
047    public ImageDataTransformer() {
048        super(FileFilterFactory.getXmlFileFilter(), "/xslt/imagedata.xsl");
049    }
050}