marker.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 strategy for marking words.
 * 
 * <p>When showing snippets to the user, it is necessary to highlight intervals, and to mark the
 * start and the end of an excerpt. The first effect is usually some kind of highlighting or boldfacing, the
 * second an ellipsis or similar punctuation. This class allows to create interchangeable markers for
 * different purposes or kind of text (e.g., {@link it.unimi.dsi.mg4j.query.TextMarker#TEXT_STANDOUT},
 * {@link it.unimi.dsi.mg4j.query.TextMarker#HTML_STRONG}, and so on).
 */
public interface Marker {
	
	/** Returns the starting delimiter of a marked part.
	 *  
	 * @return the starting delimiter of a marked part.
	 */
	public String startOfMark();

	/** Returns the ending delimiter of a marked part.
	 *  
	 * @return the ending delimiter of a marked part.
	 */
	public String endOfMark();

	/** Returns the starting delimiter of a block.
	 *  
	 * @return the starting delimiter of a block.
	 */
	public String startOfBlock();

	/** Returns the ending delimiter of a block.
	 *  
	 * @return the ending delimiter of a block.
	 */
	public String endOfBlock();
	
	/** Returns the starting delimiter of a field.
	 *  
	 * @return the starting delimiter of a field.
	 */
	public String startOfField();

	/** Returns the ending delimiter of a field.
	 *  
	 * @return the ending delimiter of a field.
	 */
	public String endOfField();
	


}