com.aspose.words

Class FieldCompare

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldCompare

public class FieldCompare
extends Field

Implements the COMPARE field.

To learn more, visit the Working with Fields documentation article.

Remarks:

Compares the values designated by the expressions getLeftExpression() / setLeftExpression(java.lang.String) and getRightExpression() / setRightExpression(java.lang.String) in comparison using the operator designated by getComparisonOperator() / setComparisonOperator(java.lang.String).

Examples:

Shows how to compare expressions using a COMPARE field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldCompare field = (FieldCompare) builder.insertField(FieldType.FIELD_COMPARE, true);
 field.setLeftExpression("3");
 field.setComparisonOperator("<");
 field.setRightExpression("2");
 field.update();

 // The COMPARE field displays a "0" or a "1", depending on its statement's truth.
 // The result of this statement is false so that this field will display a "0".
 Assert.assertEquals(" COMPARE  3 < 2", field.getFieldCode());
 Assert.assertEquals("0", field.getResult());

 builder.writeln();

 field = (FieldCompare) builder.insertField(FieldType.FIELD_COMPARE, true);
 field.setLeftExpression("5");
 field.setComparisonOperator("=");
 field.setRightExpression("2 + 3");
 field.update();

 // This field displays a "1" since the statement is true.
 Assert.assertEquals(" COMPARE  5 = \"2 + 3\"", field.getFieldCode());
 Assert.assertEquals("1", field.getResult());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.COMPARE.docx");
 
 

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComparisonOperator() Gets the comparison operator.
java.lang.String	getLeftExpression() Gets the left part of the comparison expression.
java.lang.String	getRightExpression() Gets the right part of the comparison expression.
void	setComparisonOperator(java.lang.String value) Sets the comparison operator.
void	setLeftExpression(java.lang.String value) Sets the left part of the comparison expression.
void	setRightExpression(java.lang.String value) Sets the right part of the comparison expression.

Methods inherited from class com.aspose.words.Field

getDisplayResult, getEnd, getFieldCode, getFieldCode, getFormat, getLocaleId, getResult, getSeparator, getStart, getType, isDirty, isDirty, isLocked, isLocked, needStoreOldResultNodes, remove, setLocaleId, setResult, unlink, update, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getLeftExpression

public java.lang.String getLeftExpression()

Gets the left part of the comparison expression.

Examples:

Shows how to compare expressions using a COMPARE field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldCompare field = (FieldCompare) builder.insertField(FieldType.FIELD_COMPARE, true);
 field.setLeftExpression("3");
 field.setComparisonOperator("<");
 field.setRightExpression("2");
 field.update();

 // The COMPARE field displays a "0" or a "1", depending on its statement's truth.
 // The result of this statement is false so that this field will display a "0".
 Assert.assertEquals(" COMPARE  3 < 2", field.getFieldCode());
 Assert.assertEquals("0", field.getResult());

 builder.writeln();

 field = (FieldCompare) builder.insertField(FieldType.FIELD_COMPARE, true);
 field.setLeftExpression("5");
 field.setComparisonOperator("=");
 field.setRightExpression("2 + 3");
 field.update();

 // This field displays a "1" since the statement is true.
 Assert.assertEquals(" COMPARE  5 = \"2 + 3\"", field.getFieldCode());
 Assert.assertEquals("1", field.getResult());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.COMPARE.docx");
 
 

Returns:

The left part of the comparison expression.

setLeftExpression

public void setLeftExpression(java.lang.String value)
                       throws java.lang.Exception

Sets the left part of the comparison expression.

Examples:

Shows how to compare expressions using a COMPARE field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldCompare field = (FieldCompare) builder.insertField(FieldType.FIELD_COMPARE, true);
 field.setLeftExpression("3");
 field.setComparisonOperator("<");
 field.setRightExpression("2");
 field.update();

 // The COMPARE field displays a "0" or a "1", depending on its statement's truth.
 // The result of this statement is false so that this field will display a "0".
 Assert.assertEquals(" COMPARE  3 < 2", field.getFieldCode());
 Assert.assertEquals("0", field.getResult());

 builder.writeln();

 field = (FieldCompare) builder.insertField(FieldType.FIELD_COMPARE, true);
 field.setLeftExpression("5");
 field.setComparisonOperator("=");
 field.setRightExpression("2 + 3");
 field.update();

 // This field displays a "1" since the statement is true.
 Assert.assertEquals(" COMPARE  5 = \"2 + 3\"", field.getFieldCode());
 Assert.assertEquals("1", field.getResult());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.COMPARE.docx");
 
 

Parameters:

value - The left part of the comparison expression.

Throws:

java.lang.Exception

getComparisonOperator

public java.lang.String getComparisonOperator()

Gets the comparison operator.

Examples:

Shows how to compare expressions using a COMPARE field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldCompare field = (FieldCompare) builder.insertField(FieldType.FIELD_COMPARE, true);
 field.setLeftExpression("3");
 field.setComparisonOperator("<");
 field.setRightExpression("2");
 field.update();

 // The COMPARE field displays a "0" or a "1", depending on its statement's truth.
 // The result of this statement is false so that this field will display a "0".
 Assert.assertEquals(" COMPARE  3 < 2", field.getFieldCode());
 Assert.assertEquals("0", field.getResult());

 builder.writeln();

 field = (FieldCompare) builder.insertField(FieldType.FIELD_COMPARE, true);
 field.setLeftExpression("5");
 field.setComparisonOperator("=");
 field.setRightExpression("2 + 3");
 field.update();

 // This field displays a "1" since the statement is true.
 Assert.assertEquals(" COMPARE  5 = \"2 + 3\"", field.getFieldCode());
 Assert.assertEquals("1", field.getResult());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.COMPARE.docx");
 
 

Returns:

The comparison operator.

setComparisonOperator

public void setComparisonOperator(java.lang.String value)
                           throws java.lang.Exception

Sets the comparison operator.

Examples:

Shows how to compare expressions using a COMPARE field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldCompare field = (FieldCompare) builder.insertField(FieldType.FIELD_COMPARE, true);
 field.setLeftExpression("3");
 field.setComparisonOperator("<");
 field.setRightExpression("2");
 field.update();

 // The COMPARE field displays a "0" or a "1", depending on its statement's truth.
 // The result of this statement is false so that this field will display a "0".
 Assert.assertEquals(" COMPARE  3 < 2", field.getFieldCode());
 Assert.assertEquals("0", field.getResult());

 builder.writeln();

 field = (FieldCompare) builder.insertField(FieldType.FIELD_COMPARE, true);
 field.setLeftExpression("5");
 field.setComparisonOperator("=");
 field.setRightExpression("2 + 3");
 field.update();

 // This field displays a "1" since the statement is true.
 Assert.assertEquals(" COMPARE  5 = \"2 + 3\"", field.getFieldCode());
 Assert.assertEquals("1", field.getResult());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.COMPARE.docx");
 
 

Parameters:

value - The comparison operator.

Throws:

java.lang.Exception

getRightExpression

public java.lang.String getRightExpression()

Gets the right part of the comparison expression.

Examples:

Shows how to compare expressions using a COMPARE field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldCompare field = (FieldCompare) builder.insertField(FieldType.FIELD_COMPARE, true);
 field.setLeftExpression("3");
 field.setComparisonOperator("<");
 field.setRightExpression("2");
 field.update();

 // The COMPARE field displays a "0" or a "1", depending on its statement's truth.
 // The result of this statement is false so that this field will display a "0".
 Assert.assertEquals(" COMPARE  3 < 2", field.getFieldCode());
 Assert.assertEquals("0", field.getResult());

 builder.writeln();

 field = (FieldCompare) builder.insertField(FieldType.FIELD_COMPARE, true);
 field.setLeftExpression("5");
 field.setComparisonOperator("=");
 field.setRightExpression("2 + 3");
 field.update();

 // This field displays a "1" since the statement is true.
 Assert.assertEquals(" COMPARE  5 = \"2 + 3\"", field.getFieldCode());
 Assert.assertEquals("1", field.getResult());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.COMPARE.docx");
 
 

Returns:

The right part of the comparison expression.

setRightExpression

public void setRightExpression(java.lang.String value)
                        throws java.lang.Exception

Sets the right part of the comparison expression.

Examples:

Shows how to compare expressions using a COMPARE field.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldCompare field = (FieldCompare) builder.insertField(FieldType.FIELD_COMPARE, true);
 field.setLeftExpression("3");
 field.setComparisonOperator("<");
 field.setRightExpression("2");
 field.update();

 // The COMPARE field displays a "0" or a "1", depending on its statement's truth.
 // The result of this statement is false so that this field will display a "0".
 Assert.assertEquals(" COMPARE  3 < 2", field.getFieldCode());
 Assert.assertEquals("0", field.getResult());

 builder.writeln();

 field = (FieldCompare) builder.insertField(FieldType.FIELD_COMPARE, true);
 field.setLeftExpression("5");
 field.setComparisonOperator("=");
 field.setRightExpression("2 + 3");
 field.update();

 // This field displays a "1" since the statement is true.
 Assert.assertEquals(" COMPARE  5 = \"2 + 3\"", field.getFieldCode());
 Assert.assertEquals("1", field.getResult());

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.COMPARE.docx");
 
 

Parameters:

value - The right part of the comparison expression.

Throws:

java.lang.Exception