如何使用apache POI读取和替换书签值

Question

i'm a complete novice with apache POI and i already tried several things. My problem is that i have a few bookmarks in a docx-File and i want to replace the value of them.

i already got so far that i add the text to the bookmark, but the previous value is still there

my code:

InputStream fis = new FileInputStream(fileName);
XWPFDocument document = new XWPFDocument(fis);
List<XWPFParagraph> paragraphs = document.getParagraphs();
for (XWPFParagraph paragraph : paragraphs)
{
    //Here you have your paragraph; 
    CTP ctp = paragraph.getCTP(); 
    // Get all bookmarks and loop through them 
    List<CTBookmark> bookmarks = ctp.getBookmarkStartList(); 
    for(CTBookmark bookmark : bookmarks) 
    { 
         if(bookmark.getName().equals("Firma1234"))
         {
             System.out.println(bookmark.getName());
             XWPFRun run = paragraph.createRun();
             run.setText(lcFirma);
                      ctp.getDomNode().insertBefore(run.getCTR().getDomNode(), bookmark.getDomNode());
         }
    }   
}
OutputStream out = new FileOutputStream(output);
document.write(out);
document.close();
out.close();    

the value of "lcFirma" is "Firma" the value of the Bookmark is "Testmark" my docx-File before:

Testmark -> name=Firma1234

my docx-File after:

FirmaTestmark

like i said the text is inserted before the value of the bookmark instead of replacing it, how do i replace the text instead?

Greetings,

Kevin

Answer 1

I also had similar requirement of setting the "Default text" field of a .docx bookmark. I was not able to do so, so, I did this as a workaround : Replaced the entire paragraph containing the bookmark with text. So, instead of the bookmark being populated with a default text, I had a paragraph that held the bookmarked text. In my case, the .docx had to finally converted to a .pdf file, so the absence of bookmark did not matter, but the presence of correct text was more important.

This is how I did it with Apache POI :

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import org.apache.commons.lang3.StringUtils;
import org.apache.poi.util.TempFileCreationStrategy;
import org.apache.poi.xdgf.usermodel.section.geometry.RelMoveTo;
import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFRun;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTBookmark;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTP;
import org.w3c.dom.DOMException;
import org.w3c.dom.Document;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import org.w3c.dom.UserDataHandler;

/**
 * 
 * @author binita.bharati@gmail.com
 * 
 * This code will replace bookmark with plain text. A bookmark is seen as "Text Form Field" in a .docx file.
 *
 */


public class BookmarkReplacer {

    public static void main(String[] args) throws Exception {
        replaceBookmark();

    }

    private static String replaceBookmarkedPara(String input, String bookmarkTxt) {
        char[] tmp = input.toCharArray();
        StringBuilder sb = new StringBuilder();
        int bookmarkedCharCount = 0;
        for (int i = 0 ; i < tmp.length ; i++) {
            int asciiCode = tmp[i];
            if (asciiCode == 8194) {
                bookmarkedCharCount ++;
                if (bookmarkedCharCount == 5) {
                    sb.append(bookmarkTxt);
                }
            }
            else {
                sb.append(tmp[i]);
            }
        }
        return sb.toString();
    }

    private static void removeAllRuns(XWPFParagraph paragraph) {
        int size = paragraph.getRuns().size();
        for (int i = 0; i < size; i++) {
            paragraph.removeRun(0);
        }
    }

    private static void insertReplacementRuns(XWPFParagraph paragraph, String replacedText) {
        String[] replacementTextSplitOnCarriageReturn = StringUtils.split(replacedText, "\n");

        for (int j = 0; j < replacementTextSplitOnCarriageReturn.length; j++) {
            String part = replacementTextSplitOnCarriageReturn[j];

            XWPFRun newRun = paragraph.insertNewRun(j);
            newRun.setText(part);

            if (j+1 < replacementTextSplitOnCarriageReturn.length) {
                newRun.addCarriageReturn();
            }
        }       
    }

    public static void replaceBookmark () throws Exception 
    {
    InputStream fis = new FileInputStream("C:\\input.docx");
    XWPFDocument document = new XWPFDocument(fis);
    List<XWPFParagraph> paragraphs = document.getParagraphs();
    for (XWPFParagraph paragraph : paragraphs)
    {
        //Here you have your paragraph; 
        CTP ctp = paragraph.getCTP(); 
        // Get all bookmarks and loop through them 
        List<CTBookmark> bookmarks = ctp.getBookmarkStartList(); 
        for(CTBookmark bookmark : bookmarks) 
        { 
             if(bookmark.getName().equals("data_incipit") || bookmark.getName().equals("incipit_Codcli")
                     || bookmark.getName().equals("Incipit_titolo"))
             {

                 String paraText = paragraph.getText();
                 System.out.println("paraText = "+paraText +" for bookmark name "+bookmark.getName());
                 String replacementText = replaceBookmarkedPara(paraText, "haha");
                 removeAllRuns(paragraph);
                 insertReplacementRuns(paragraph, replacementText);

             }
        }   
    }
    OutputStream out = new FileOutputStream("C:\\output.docx");
    document.write(out);
    document.close();
    out.close();  
}
}

Answer 2

Try below code

private List<XWPFParagraph> collectParagraphs()
    {
        List<XWPFParagraph> paragraphs = new ArrayList<>();
        paragraphs.addAll(this.document.getParagraphs());

        for (XWPFTable table : this.document.getTables())
        {
            for (XWPFTableRow row : table.getRows())
            {
                for (XWPFTableCell cell : row.getTableCells())
                    paragraphs.addAll(cell.getParagraphs());
            }
        }
        return paragraphs;
    }

    public List<String> getBookmarkNames()
    {
        List<String> bookmarkNames = new ArrayList<>();
        Iterator<XWPFParagraph> paraIter = null;
        XWPFParagraph para = null;
        List<CTBookmark> bookmarkList = null;
        Iterator<CTBookmark> bookmarkIter = null;
        CTBookmark bookmark = null;
        XWPFRun run = null;

        // Get an Iterator for the XWPFParagraph object and step through them
        // one at a time.
        paraIter = collectParagraphs().iterator();
        while (paraIter.hasNext())
        {
            para = paraIter.next();

            // Get a List of the CTBookmark object sthat the paragraph
            // 'contains' and step through these one at a time.
            bookmarkList = para.getCTP().getBookmarkStartList();
            bookmarkIter = bookmarkList.iterator();
            while (bookmarkIter.hasNext())
            {
                bookmark = bookmarkIter.next();
                bookmarkNames.add(bookmark.getName());
            }
        }
        return bookmarkNames;
    }