Package net.sf.okapi.steps.common

Class ExtractionVerificationUtil

java.lang.Object

net.sf.okapi.steps.common.ExtractionVerificationUtil

public class ExtractionVerificationUtil
extends Object

Reused the test-scoped FilterTestDriver. Could probably be generalized and moved to the resources themselves or into a helper class.

Constructor Summary

Constructors

Constructor	Description
ExtractionVerificationUtil()
ExtractionVerificationUtil(boolean compareSkeleton)

Method Summary

Modifier and Type	Method	Description
boolean	bothAreNull(Object o1, Object o2)	Checks if both objects are null
boolean	compareBaseReferenceable(BaseReferenceable br1, BaseReferenceable br2)	Compare two BaseReferenceables
boolean	compareIMultilingual(IMultilingual n1, IMultilingual n2)
boolean	compareINameables(INameable n1, INameable n2)	Compare two INameables (Assuming isTranslatable() and preserveWhitespaces() do not return null)
boolean	compareIReferenceables(IReferenceable r1, IReferenceable r2)	Compare two IReferenceables (Assuming isReferent() and referenceCount() do not return null)
boolean	compareIResources(IResource r1, IResource r2)	Compare two IResources (Assuming isTranslatable() and preserveWhitespaces() do not return null)
boolean	compareProperties(Property p1, Property p2)	Compare two Properties
boolean	compareSegments(Segment seg1, Segment seg2)	Compares two Segments.
boolean	compareStartSubDocument(StartSubDocument ssd1, StartSubDocument ssd2)	Compare two StartSubDocuments
boolean	compareTextContainers(TextContainer tc1, TextContainer tc2)	Compares two TextContainers.
boolean	compareTextContainers(TextContainer tc1, TextContainer tc2, boolean allowPropValChanges)	Compares two TextContainers.
boolean	compareTextFragments(TextFragment tf1, TextFragment tf2)	Compares two TextFragments.
boolean	compareTextParts(TextPart tp1, TextPart tp2)	Compares two TextPart.
boolean	compareTextUnits(ITextUnit tu1, ITextUnit tu2)	Compare two ITextUnits
LocaleId	getTargetLocale()
boolean	isCompareSkeleton()
boolean	isMultilingual()
boolean	isTargetLocaleOverriden()
boolean	oneIsNulll(Object o1, Object o2, String function, String type)	Checks if one object is null
void	setCompareSkeleton(boolean compareSkeleton)
void	setMultilingual(boolean isMultilingual)
void	setTargetLocale(LocaleId targetLocale)
void	setTargetLocaleOverriden(boolean targetLocaleOverriden)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtractionVerificationUtil

public ExtractionVerificationUtil()

ExtractionVerificationUtil

public ExtractionVerificationUtil(boolean compareSkeleton)

Method Detail

isCompareSkeleton

public boolean isCompareSkeleton()

setCompareSkeleton

public void setCompareSkeleton(boolean compareSkeleton)

isMultilingual

public boolean isMultilingual()

setMultilingual

public void setMultilingual(boolean isMultilingual)

getTargetLocale

public LocaleId getTargetLocale()

setTargetLocale

public void setTargetLocale(LocaleId targetLocale)

isTargetLocaleOverriden

public boolean isTargetLocaleOverriden()

setTargetLocaleOverriden

public void setTargetLocaleOverriden(boolean targetLocaleOverriden)

compareStartSubDocument

public boolean compareStartSubDocument(StartSubDocument ssd1,
                                       StartSubDocument ssd2)

Compare two StartSubDocuments

Parameters:

ssd1 - First StartSubDocument

ssd2 - Second StartSubDocument

Returns:

true if equal else false

compareBaseReferenceable

public boolean compareBaseReferenceable(BaseReferenceable br1,
                                        BaseReferenceable br2)

Compare two BaseReferenceables

Parameters:

br1 - First BaseReferenceable

br2 - Second BaseReferenceable

Returns:

true if equal else false

compareTextUnits

public boolean compareTextUnits(ITextUnit tu1,
                                ITextUnit tu2)

Compare two ITextUnits

Parameters:

tu1 - First ITextUnit

tu2 - Second ITextUnit

Returns:

true if equal else false

compareTextContainers

public boolean compareTextContainers(TextContainer tc1,
                                     TextContainer tc2)

Compares two TextContainers.

Parameters:

tc1 - First TextContainer

tc2 - Second TextContainer

Returns:

true if equal else false

compareTextContainers

public boolean compareTextContainers(TextContainer tc1,
                                     TextContainer tc2,
                                     boolean allowPropValChanges)

Compares two TextContainers.

Parameters:

tc1 - First TextContainer

tc2 - Second TextContainer

allowPropValChanges - In the cases of multilingual formats some properties values may change such as target lang

Returns:

true if equal else false

compareSegments

public boolean compareSegments(Segment seg1,
                               Segment seg2)

Compares two Segments.

Parameters:

seg1 - First Segment

seg2 - Second Segment

Returns:

true if equal else false

compareTextParts

public boolean compareTextParts(TextPart tp1,
                                TextPart tp2)

Compares two TextPart.

Parameters:

tp1 - First TextPart

tp2 - Second TextPart

Returns:

true if equal else false

compareTextFragments

public boolean compareTextFragments(TextFragment tf1,
                                    TextFragment tf2)

Compares two TextFragments. Basically it's the TextFragments own compareTo with additional null checks

Parameters:

tf1 - First TextFragment

tf2 - Second TextFragment

Returns:

true if equal else false

compareINameables

public boolean compareINameables(INameable n1,
                                 INameable n2)

Compare two INameables (Assuming isTranslatable() and preserveWhitespaces() do not return null)

Parameters:

n1 - First INameable

n2 - Second INameable

Returns:

true if equal else false

compareIResources

public boolean compareIResources(IResource r1,
                                 IResource r2)

Compare two IResources (Assuming isTranslatable() and preserveWhitespaces() do not return null)

Parameters:

r1 - First IResource

r2 - Second IResource

Returns:

true if equal else false

compareIMultilingual

public boolean compareIMultilingual(IMultilingual n1,
                                    IMultilingual n2)

compareIReferenceables

public boolean compareIReferenceables(IReferenceable r1,
                                      IReferenceable r2)

Compare two IReferenceables (Assuming isReferent() and referenceCount() do not return null)

Parameters:

r1 - First IReferencable

r2 - Second IReferencable

Returns:

true if equal else false

compareProperties

public boolean compareProperties(Property p1,
                                 Property p2)

Compare two Properties

Parameters:

p1 - First Property

p2 - Second Property

Returns:

true if equal else false

bothAreNull

public boolean bothAreNull(Object o1,
                           Object o2)

Checks if both objects are null

Parameters:

o1 - First Object

o2 - Second Object

Returns:

true if both are null else false

oneIsNulll

public boolean oneIsNulll(Object o1,
                          Object o2,
                          String function,
                          String type)

Checks if one object is null

Parameters:

o1 - First Object

o2 - Second Object

function - The function initiating the call. Used for logging.

type - The object type. Used for logging.

Returns:

True if one object is null