r/org.eclipse.statet.r.core/src/org/eclipse/statet/r/core/rhelp/IRHelpSearchMatch.java

/*=============================================================================#
 # Copyright (c) 2010, 2017 Stephan Wahlbrink and others.
 # 
 # This program and the accompanying materials are made available under the
 # terms of the Eclipse Public License 2.0 which is available at
 # https://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 # which is available at https://www.apache.org/licenses/LICENSE-2.0.
 # 
 # SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 # 
 # Contributors:
 #     Stephan Wahlbrink <sw@wahlbrink.eu> - initial API and implementation
 #=============================================================================*/

package org.eclipse.statet.r.core.rhelp;

import java.util.regex.Pattern;


public interface IRHelpSearchMatch {
	
	
	String PRE_TAGS_PREFIX= "<EMATCH-"; //$NON-NLS-1$
	
	String[] PRE_TAGS= new String[] {
			"<EMATCH-A>", //$NON-NLS-1
			"<EMATCH-B>", //$NON-NLS-1$
			"<EMATCH-C>", //$NON-NLS-1$
			"<EMATCH-D>", //$NON-NLS-1$
			"<EMATCH-E>", //$NON-NLS-1$
			"<EMATCH-F>", //$NON-NLS-1$
			"<EMATCH-G>", //$NON-NLS-1$
			"<EMATCH-H>", //$NON-NLS-1$
			"<EMATCH-I>", //$NON-NLS-1$
			"<EMATCH-J>", //$NON-NLS-1$
	};
	String[] POST_TAGS= new String[] {
			"</EMATCH-A>", //$NON-NLS-1$
			"</EMATCH-B>", //$NON-NLS-1$
			"</EMATCH-C>", //$NON-NLS-1$
			"</EMATCH-D>", //$NON-NLS-1$
			"</EMATCH-E>", //$NON-NLS-1$
			"</EMATCH-F>", //$NON-NLS-1$
			"</EMATCH-G>", //$NON-NLS-1$
			"</EMATCH-H>", //$NON-NLS-1$
			"</EMATCH-I>", //$NON-NLS-1$
			"</EMATCH-J>", //$NON-NLS-1$
	};
	Pattern ALL_TAGS_PATTERN= Pattern.compile("\\<\\/?EMATCH\\-[A-Z]\\>"); //$NON-NLS-1$
	
	interface MatchFragment {
		
		String getField();
		
		String getFieldLabel();
		
		String getText();
		
	}
	
	
	IRHelpPage getPage();
	
	float getScore();
	
	int getMatchesCount();
	
	MatchFragment[] getBestFragments();
	
}