Unified Typesetting API M1-20040817

de.inghuimische.uta.qm
Class QualityManager

java.lang.Object
  extended byde.inghuimische.uta.qm.QualityManager

public class QualityManager
extends Object

A quality manager has the capability to tell you how good an UTA typesetter is. The manager generates a quality report which can help you to

  1. find situations where subcomponents with different quality levels can not profit from the additional features (e.g. a low-level linebreaker won't profit from a high-level ItemBuilder)
  2. help a customer answer questions like "Will this configuration do for my requirements? Can I add other components to fulfill my requirements?"

Note: The manager does no absolute measurement, comparing a defined input with a defined output, the quality report is generated upon the information provided by the various subcomponents. See my diploma thesis for more details how to interpret the resulting report.

Author:
Christian Ziesemer

Field Summary
protected  ReferenceList justificationReference
           
protected  ReferenceList linebreakReference
           
protected  Hashtable localeReferences
          The mapping between locale and reference list.
protected  ReferenceList typesetReference
           
 
Constructor Summary
QualityManager()
           
 
Method Summary
 void addScriptReference(Locale aLocale, ReferenceList scriptReference)
          Adds a reference list for a script with the given locale.
 ReferenceList getJustificationReference()
          Returns the justificationReference.
 ReferenceList getLinebreakReference()
          Returns the linebreakReference.
 ReferenceList getScriptReference(Locale aLocale)
          Returns the script reference list for the given locale.
 ReferenceList getTypesetterReference()
          Returns the typesetter reference list.
 QualityReport qualityOf(Typesetter aTypesetter)
          Creates a quality report for the given typesetter.
 void setJustificationReference(ReferenceList justificationRef)
          Sets the reference used for the justification algorithm.
 void setLinebreakReference(ReferenceList linebreakReference)
          Sets the reference used for linebreak component.
 void setTypesetterReference(ReferenceList typesetReference)
          Sets the reference used for the typesetter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

localeReferences

protected Hashtable localeReferences
The mapping between locale and reference list.


typesetReference

protected ReferenceList typesetReference

linebreakReference

protected ReferenceList linebreakReference

justificationReference

protected ReferenceList justificationReference
Constructor Detail

QualityManager

public QualityManager()
Method Detail

qualityOf

public QualityReport qualityOf(Typesetter aTypesetter)
Creates a quality report for the given typesetter.

Parameters:
aTypesetter - The typesetter to check.
Returns:
A quality report generated from the information provided through the typesetter.

addScriptReference

public void addScriptReference(Locale aLocale,
                               ReferenceList scriptReference)
Adds a reference list for a script with the given locale.

Parameters:
aLocale - The locale of the script.
scriptReference - The reference list.
Throws:
NullPointerException - If either aLocale or scriptReference is null.

setTypesetterReference

public void setTypesetterReference(ReferenceList typesetReference)
Sets the reference used for the typesetter.

Parameters:
typesetReference - The typesetter reference.

setJustificationReference

public void setJustificationReference(ReferenceList justificationRef)
Sets the reference used for the justification algorithm.

Parameters:
justificationRef - The justification algorithm reference.

setLinebreakReference

public void setLinebreakReference(ReferenceList linebreakReference)
Sets the reference used for linebreak component.

Parameters:
linebreakReference - The linebreak reference.

getLinebreakReference

public ReferenceList getLinebreakReference()
Returns the linebreakReference.

Returns:
Returns the linebreakReference.

getJustificationReference

public ReferenceList getJustificationReference()
Returns the justificationReference.

Returns:
Returns the justificationReference.

getScriptReference

public ReferenceList getScriptReference(Locale aLocale)
Returns the script reference list for the given locale.

Returns:
The script reference list for the given locale.

getTypesetterReference

public ReferenceList getTypesetterReference()
Returns the typesetter reference list.

Returns:
The typesetter reference list.

Unified Typesetting API M1-20040817


An inghuimische.de project.
Copyright (C) 2004 Christian Ziesemer; See the Mozilla Public License for more details.