textmarker.java

MG4J (Managing Gigabytes for Java) is a free full-text search engine for large document collections

package it.unimi.dsi.mg4j.query;


/*		 
 * MG4J: Managing Gigabytes for Java
 *
 * Copyright (C) 2005-2007 Sebastiano Vigna 
 *
 *  This library is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU Lesser General Public License as published by the Free
 *  Software Foundation; either version 2.1 of the License, or (at your option)
 *  any later version.
 *
 *  This library is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 *  or FITfNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 *  for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */


/** A marker for text/HTML output.
 * 
 * <p>This class has few instances, which are accessible by means of final static fields. 
 */

public class TextMarker implements Marker {
	/** A text marker showing the marked text in (ANSI) standout mode, with blocks surrounded by <samp>"&#46;&#46;"</samp> and terminated by a newline. */
	public final static TextMarker TEXT_STANDOUT = new TextMarker( "\u001B[7m", "\u001B[m", "...", "...   ", "", "\n" );
	/** A text marker showing the marked text in (ANSI) boldface, with blocks surrounded by <samp>"&#46;&#46;&#46;"</samp> and terminated by a newline. */
	public final static TextMarker TEXT_BOLDFACE = new TextMarker( "\u001B[1m", "\u001B[m", "...", "...   ", "", "\n" );
	/** An HTML marker showing the marked text in a <samp>strong</samp> element, surrounded by hellipsis (<samp>&hellip;</samp>) and terminated by a newline. */
	public final static TextMarker HTML_STRONG = new TextMarker( "<strong>", "</strong>", "\u2026", "\u2026\n", "<p>", "</p>" );
	
	public final String startOfMark;
	public final String endOfMark;
	public final String startOfBlock;
	public final String endOfBlock;
	public final String startOfField;
	public final String endOfField;
	
	private TextMarker( final String startOfMark, final String endOfMark, final String startOfBlock, final String endOfBlock, final String startOfField, final String endOfField ) {
		this.startOfMark = startOfMark;
		this.endOfMark = endOfMark;
		this.startOfBlock = startOfBlock;
		this.endOfBlock = endOfBlock;
		this.startOfField = startOfField;
		this.endOfField = endOfField;
	}
	
	public final String endOfBlock() {
		return endOfBlock;
	}
	public final String endOfField() {
		return endOfField;
	}
	public final String endOfMark() {
		return endOfMark;
	}
	public final String startOfBlock() {
		return startOfBlock;
	}
	public final String startOfField() {
		return startOfField;
	}
	public final String startOfMark() {
		return startOfMark;
	}
}