fr.opensagres.xdocreport.document.docx.DocxUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fr.opensagres.xdocreport.document.docx Show documentation
The newest version!
/**
 * Copyright (C) 2011 Angelo Zerr  and Pascal Leclercq 
 *
 * All rights reserved.
 *
 * Permission is hereby granted, free  of charge, to any person obtaining
 * a  copy  of this  software  and  associated  documentation files  (the
 * "Software"), to  deal in  the Software without  restriction, including
 * without limitation  the rights to  use, copy, modify,  merge, publish,
 * distribute,  sublicense, and/or sell  copies of  the Software,  and to
 * permit persons to whom the Software  is furnished to do so, subject to
 * the following conditions:
 *
 * The  above  copyright  notice  and  this permission  notice  shall  be
 * included in all copies or substantial portions of the Software.
 *
 * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,
 * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF
 * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
package fr.opensagres.xdocreport.document.docx;

import fr.opensagres.xdocreport.core.io.XDocArchive;

/**
 * Utilities for docx.
 * 
 */
public class DocxUtils implements DocXConstants {

	/**
	 * Returns true if the given document archive is a docx and false otherwise.
	 * 
	 * @param documentArchive
	 * @return
	 */

	public static boolean isDocx(XDocArchive documentArchive) {
		if (!documentArchive.hasEntry(CONTENT_TYPES_XML)) {
			return false;
		}
		// TODO check from [Content_Types].xml
		// 
		return documentArchive.getEntryNames(DocXReport.WORD_REGEXP).size() > 0;
	}

	/**
	 * Returns true if current element is w:fldSimple and false otherwise.
	 * 
	 * @param uri
	 * @param localName
	 * @param name
	 * @return
	 */
	public static boolean isFldSimple(String uri, String localName, String name) {
		return (W_NS.equals(uri) && FLDSIMPLE_ELT.equals(localName));
	}

	/**
	 * Returns true if current element is w:fldSimple with MERGEFIELD type and
	 * false otherwise.
	 * 
	 * If element is w:fldSimple :
	 * 
	 * 	 * 
	 * 		
	 * 			
	 * 				
	 * 				
	 * 				?${name}?
	 * 		
	 * 	
	 * 
	 * 
	 * it is transformed with
	 * 
	 * 	 * 
	 * 			
	 * 				
	 * 				
	 * 				${name}
	 * 		
	 * 
	 * 
	 * 
	 * @param uri
	 * @param localName
	 * @param name
	 * @return
	 */

	public static boolean isP(String uri, String localName, String name) {
		return (W_NS.equals(uri) && P_ELT.equals(localName));
	}

	public static boolean isR(String uri, String localName, String name) {
		return (W_NS.equals(uri) && R_ELT.equals(localName));
	}

	public static boolean isT(String uri, String localName, String name) {
		return (W_NS.equals(uri) && T_ELT.equals(localName));
	}

	public static boolean isFldChar(String uri, String localName, String name) {
		return (W_NS.equals(uri) && FLDCHAR_ELT.equals(localName));
	}

	public static boolean isInstrText(String uri, String localName, String name) {
		return (W_NS.equals(uri) && INSTR_TEXT_ELT.equals(localName));
	}

	/**
	 * Returns true if current element is w:bookmarkStart and false otherwise.
	 * 
	 * @param uri
	 * @param localName
	 * @param name
	 * @return
	 */
	public static boolean isBookmarkStart(String uri, String localName, String name) {
		return (W_NS.equals(uri) && BOOKMARK_START_ELT.equals(localName));
	}

	/**
	 * Returns true if current element is w:bookmarkEnd and false otherwise.
	 * 
	 * @param uri
	 * @param localName
	 * @param name
	 * @return
	 */
	public static boolean isBookmarkEnd(String uri, String localName, String name) {
		return (W_NS.equals(uri) && BOOKMARK_END_ELT.equals(localName));
	}

	/**
	 * Returns true if current element is a:blip and false otherwise.
	 * 
	 * @param uri
	 * @param localName
	 * @param name
	 * @return
	 */
	public static boolean isBlip(String uri, String localName, String name) {
		return (A_NS.equals(uri) && BLIP_ELT.equals(localName));
	}

	/**
	 * Returns true if current element is w:hyperlink and false otherwise.
	 * 
	 * @param uri
	 * @param localName
	 * @param name
	 * @return
	 */
	public static boolean isHyperlink(String uri, String localName, String name) {
		return (W_NS.equals(uri) && HYPERLINK_ELT.equals(localName));
	}
}