poi/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFComments.java

/* ====================================================================
   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.usermodel.extensions;

import org.apache.poi.xssf.usermodel.XSSFComment;
import org.apache.poi.xssf.util.CellReference;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTAuthors;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComment;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTCommentList;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTComments;

public class XSSFComments {
	
	private CTComments comments;

	public XSSFComments() {
		this(CTComments.Factory.newInstance());
	}

	public XSSFComments(CTComments comments) {
		this.comments = comments;
	}

	public String getAuthor(long authorId) {
		return getCommentsAuthors().getAuthorArray((int)authorId);
	}
	
	public int findAuthor(String author) {
		for (int i = 0 ; i < getCommentsAuthors().sizeOfAuthorArray() ; i++) {
			if (getCommentsAuthors().getAuthorArray(i).equals(author)) {
				return i;
			}
		}
		return addNewAuthor(author);
	}
	
	public XSSFComment findCellComment(int row, int column) {
		return findCellComment(new CellReference().convertRowColToString((short)row, (short)column));
	}
	
	public XSSFComment findCellComment(String cellRef) {
		for (CTComment comment : getCommentsList().getCommentArray()) {
			if (cellRef.equals(comment.getRef())) {
				return new XSSFComment(this, comment);
			}
		}
		return null;
	}
	
	public void setCellComment (int row, int column, XSSFComment comment) {
		XSSFComment current = findCellComment(row, column);
		if (current == null) {
			current = addComment();
		}
		current = comment;
		current.setRow(row);
		current.setColumn((short) column);
	}
	
	public void setCellComment (String cellRef, XSSFComment comment) {
		CellReference cellReference = new CellReference(cellRef);
		setCellComment(cellReference.getRow(), cellReference.getCol(), comment);
	}

	public XSSFComment addComment() {
		return new XSSFComment(this, getCommentsList().addNewComment());
	}

	private CTCommentList getCommentsList() {
		if (comments.getCommentList() == null) {
			comments.addNewCommentList();
		}
		return comments.getCommentList();
	}

	private CTAuthors getCommentsAuthors() {
		if (comments.getAuthors() == null) {
			comments.addNewAuthors();
		}
		return comments.getAuthors();
	}
	
	private int addNewAuthor(String author) {
		int index = getCommentsAuthors().sizeOfAuthorArray();
		getCommentsAuthors().insertAuthor(index, author);
		return index;
	}

}