net.sf.okapi.lib.segmentation.Rule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of okapi-lib Show documentation
There is a newer version: 1.47.0
/*===========================================================================
  Copyright (C) 2008 by the Okapi Framework contributors
-----------------------------------------------------------------------------
  Licensed 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 net.sf.okapi.lib.segmentation;

/**
 * Stores the data for a SRX <rule> element.
 */
public class Rule {

	/**
	 * Pattern for before the break point.
	 */
	protected String before;
	
	/**
	 * Pattern for after the break point.
	 */
	protected String after;
	
	/**
	 * Flag indicating if the rule is a breaking rule.
	 */
	protected boolean isBreak;
	
	/**
	 * Flag indicating if the rule is active.
	 */
	protected boolean isActive;

	/**
	 * Optional comment placed just before the rule.
	 */
	protected String comment;
	
	/**
	 * Creates an empty breaking and active Rule object. 
	 */
	public Rule () {
		before = "";
		after = "";
		isBreak = true;
		isActive = true;
		comment = null;
	}
	
	/**
	 * Creates a Rule object with given patterns and a flag indicating if the rule
	 * is a breaking one or a breaking exception.
	 * @param before the pattern for before the break point.
	 * @param after the pattern for after the break point.
	 * @param isBreak true if the rule is a breaking rule, false if it is a
	 * breaking exception.
	 */
	public Rule (String before,
		String after,
		boolean isBreak)
	{
		if ( before == null ) this.before = "";
		else this.before = before;
		
		if ( after == null ) this.after = "";
		else this.after = after;
		
		this.isBreak = isBreak;
		isActive = true;
	}
	
	/**
	 * Gets the pattern before the break point for this rule.
	 * @return the pattern before the break point for this rule.
	 */
	public String getBefore () {
		return before;
	}
	
	/**
	 * Sets the pattern before the break point for this rule.
	 * @param value the new pattern before the break point for this rule.
	 */
	public void setBefore (String value) {
		before = value;
	}
	
	/**
	 * Gets the pattern after the break point for this rule.
	 * @return the pattern after the break point for this rule.
	 */
	public String getAfter () {
		return after;
	}
	
	/**
	 * Sets the pattern after the break point for this rule.
	 * @param value the new pattern after the break point for this rule.
	 */
	public void setAfter (String value) {
		after = value;
	}
	
	/**
	 * Indicates if this rule is a breaking rule.
	 * @return true if this rule is a breaking rule, false if it is a
	 * breaking exception.
	 */
	public boolean isBreak () {
		return isBreak;
	}
	
	/**
	 * Sets the flag indicating if this rule is a breaking rule.
	 * @param value true if this rule is a breaking rule, false if it is a
	 * breaking exception.
	 */
	public void setBreak (boolean value) {
		isBreak = value;
	}
	
	/**
	 * Indicates if this rule is active.
	 * @return true if this rule is active, false otherwise.
	 */
	public boolean isActive () {
		return isActive;
	}
	
	/**
	 * Sets the flag indicating if this rule is active.
	 * @param value true if this rule is active, false otherwise.
	 */
	public void setActive (boolean value) {
		isActive = value;
	}

	/**
	 * Gets the optional comment for this rule.
	 * @return the comment for this rule, or null if there is none.
	 */
	public String getComment () {
		return comment;
	}
	
	/**
	 * Sets the comment for this rule.
	 * @param text the new comment. Use null or empty string to remove the comment.
	 */
	public void setComment (String text) {
		comment = text;
		if (( comment != null ) && ( comment.length() == 0 )) {
			comment = null;
		}
	}

}