org.apache.poi.xssf.model.ParagraphPropertyFetcher Maven / Gradle / Ivy

Go to download
/*
 *  ====================================================================
 *    Licensed to the Apache Software Foundation (ASF) under one or more
 *    contributor license agreements.  See the NOTICE file distributed with
 *    this work for additional information regarding copyright ownership.
 *    The ASF licenses this file to You under the Apache License, Version 2.0
 *    (the "License"); you may not use this file except in compliance with
 *    the License.  You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 * ====================================================================
 */

package org.apache.poi.xssf.model;

import org.openxmlformats.schemas.drawingml.x2006.main.CTTextParagraphProperties;
import org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShape;
import org.apache.xmlbeans.XmlObject;
import org.apache.poi.util.Internal;

import static org.apache.poi.xssf.usermodel.XSSFRelation.NS_DRAWINGML;

/**
 *  Used internally to navigate the paragraph text style hierarchy within a shape and fetch properties
*/
@Internal
public abstract class ParagraphPropertyFetcher {

    private T _value;
    private int _level;
    
    public T getValue(){
        return _value;
    }

    public void setValue(T val){
        _value = val;
    }

    public ParagraphPropertyFetcher(int level) {
        _level = level;
    }

    /**
    *
    * @param shape the shape being examined
    * @return true if the desired property was fetched
    */    
    public boolean fetch(CTShape shape) {

        XmlObject[] o = shape.selectPath(
                "declare namespace xdr='http://schemas.openxmlformats.org/drawingml/2006/spreadsheetDrawing' " +
                "declare namespace a='" + NS_DRAWINGML + "' " +
                ".//xdr:txBody/a:lstStyle/a:lvl" + (_level + 1) + "pPr"
        );
        if (o.length == 1) {
            CTTextParagraphProperties props = (CTTextParagraphProperties) o[0];
            return fetch(props);
        }
        return false;
    }

    public abstract boolean fetch(CTTextParagraphProperties props);
}