#include <IPreflightResultRecord.h>

Inheritance diagram for IPreflightResultRecord:

Public Types
enum	{ kDefaultIID = IID_IPREFLIGHTRESULTRECORD }

Public Member Functions
virtual void	SetObjectID (const PreflightObjectID &objid)=0

virtual const PreflightObjectID &	GetObjectID () const =0

virtual bool	AddSubpart (ClassID subpartID)=0

virtual bool	AddSubparts (const K2Vector< ClassID > &subparts)=0

virtual bool	AddSubparts (const IPreflightResultRecord *iOther)=0

virtual void	GetSubparts (K2Vector< ClassID > &subparts) const =0

virtual bool	HasSubpart (ClassID subpartID) const =0

virtual bool	HasCommonSubpart (ClassID *commonID) const =0

virtual bool	AddValue (const PMReal &r)=0

virtual bool	AddValues (const K2Vector< PMReal > &values)=0

virtual bool	AddValues (const IPreflightResultRecord *iOther)=0

virtual void	GetValues (K2Vector< PMReal > &values) const =0

virtual PMReal	GetMinValue () const =0

virtual PMReal	GetMaxValue () const =0

virtual bool	HasCommonValue (PMReal *pCommon=nil) const =0

virtual void	SetCriteria (ClassID criteriaID)=0

virtual ClassID	GetCriteria () const =0

virtual void	SetAuxString (const PMString &s)=0

virtual PMString	GetAuxString () const =0

virtual void	SetProcessNode (IPreflightProcess::NodeID nodeID)=0

virtual IPreflightProcess::NodeID	GetProcessNode () const =0

virtual void	ReadData (PreflightXferStream &s)=0

virtual void	WriteData (PreflightXferStream &s) const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

This interface would normally be used by a preflight rule implementation.

See Also: IPreflightRuleVisitor

This interface has two main purposes: it records data for a preflight rule visit, and later serves as a mechanism for organizing those results when aggregating. Normally a preflight result record is created in your rule visitor via IPreflightVisitInfo::CreateResultRecord but if you want to create your own during results aggregation you can use IPreflightAggregatedResultsUtils::CreatePreflightResultRecord.

See Also: IPreflightResultRecordTable; IPreflightAggregatedResultsUtils

The fields in the result record are meant to be generic in nature, ie rule-dependent. Their sole purpose is to aid in recording and aggregating records together. In all cases the preflight result record is associated with a preflight object ID. In some cases that may be all you need, in which case your use of this interface is trivial. In other cases you'll want to record more detailed information about the violation. It's purely a question of what information you need to display later on during the aggregation phase, and/or whether that information is inexpensive to obtain later and therefore you don't care about recording it when you find the error.

As an example, the font types rule records the name of the font in the aux string field, because that makes it easy later to create subtables by aux string value and it's mildly complex to re-obtain the font name later, so it's more efficient to record it in the Visit() phase.

To save you the trouble of scanning through all the APIs below, the data stored in a record includes:

The PreflightObjectID of the associated object
A vector of subpart IDs, indicating which subpart(s) are associated
A vector of PMReal values, which your rule can use however it likes
A criteria ID, which is typically used to indicate what category of failure this is, if your rule has mutliple failure categories
An aux string, which your rule can use however it likes
A process node, indicating the node in the related process is associated with this record (if any).

Member Function Documentation

virtual bool IPreflightResultRecord::AddSubpart ( ClassID subpartID )

pure virtual

Add a subpart to the record. Each record has a vector of subparts. This is normally auto-setup by IPreflightAggregatedResultsUtils, but there's no reason you can't make up your own subparts and apply them at the time you encounter the error.

Parameters

subpartID IN The subpart to add to the vector.

Returns: true if the subpart was not already in the vector (ie the vector changed).

virtual bool IPreflightResultRecord::AddSubparts ( const K2Vector< ClassID > & subparts )

pure virtual

Merge a vector of subparts with the record's vector.

Parameters

subparts IN The vector of subparts to add.

Returns: true if subparts were added (ie one or more were not already in there).

virtual bool IPreflightResultRecord::AddSubparts ( const IPreflightResultRecord * iOther )

pure virtual

Merge another record's subparts into this record's vector.

Parameters

iOther IN The other record.

Returns: true if subparts were added (ie one or more were not already in there).

virtual bool IPreflightResultRecord::AddValue ( const PMReal & r )

pure virtual

Add a value to the record. Each record has a vector of PMReal values. These are completely 'untyped' otherwise; what a value is depends entirely on your rule. However, preflight aggregation utilities will tend to aggregate together values. For example, if your value is the width of a stroke you encounter, the aggregation utilities may aggregate together records with everything else the same except the values; in that case the value vectors are merged.

Parameters

r	IN The value to add to the vector.

Returns: true if the value was not already in the vector (ie the vector changed).

virtual bool IPreflightResultRecord::AddValues ( const K2Vector< PMReal > & values )

pure virtual

Merge a vector of values with the record's vector.

Parameters

values IN The vector of values to add.

Returns: true if values were added (ie one or more were not already in there).

virtual bool IPreflightResultRecord::AddValues ( const IPreflightResultRecord * iOther )

pure virtual

Merge another record's values into this record's vector.

Parameters

iOther IN The other record.

Returns: true if values were added (ie one or more were not already in there).

virtual PMString IPreflightResultRecord::GetAuxString ( ) const

pure virtual

Returns: the aux string for the record.

virtual ClassID IPreflightResultRecord::GetCriteria ( ) const

pure virtual

Returns: the criteria for this record.

virtual PMReal IPreflightResultRecord::GetMaxValue ( ) const

pure virtual

Get the maximum value found in the vector.

Returns: the maximum value or 0 if there are no values.

virtual PMReal IPreflightResultRecord::GetMinValue ( ) const

pure virtual

Get the minimum value found in the vector.

Returns: the minimum value or 0 if there are no values.

virtual const PreflightObjectID& IPreflightResultRecord::GetObjectID ( ) const

pure virtual

Get the related object ID.

Returns: the object ID. NOTE that this is const reference so be careful about the scope; if in doubt, copy to a local PreflightObjectID variable. The const reference is used here because it's moderately expensive to duplicate a PreflightObjectID and the result is often passed to utiltities that take a const reference, so we save a lot of copying.

virtual IPreflightProcess::NodeID IPreflightResultRecord::GetProcessNode ( ) const

pure virtual

Returns: the associated process node ID. 0 if there is none.

virtual void IPreflightResultRecord::GetSubparts ( K2Vector< ClassID > & subparts ) const

pure virtual

Get the subparts in this record's subpart vector.

Parameters

subparts OUT Receives the subpart vector.

virtual void IPreflightResultRecord::GetValues ( K2Vector< PMReal > & values ) const

pure virtual

Get the values in this record's values vector.

Parameters

values OUT Receives the values vector.

virtual bool IPreflightResultRecord::HasCommonSubpart ( ClassID * commonID ) const

pure virtual

Returns whether the subpart vector is of size 1 (ie, all of the subparts added have been the same value), and optionally returns what that common value is.

Parameters

commonID OUT If not nil, receives the common value if there is one, or kInvalidClass if there isn't.

Returns: true iff the subpart vector is of size 1, indicating that after aggregation there was no mixed subpart.

virtual bool IPreflightResultRecord::HasCommonValue ( PMReal * pCommon = nil ) const

pure virtual

Returns whether the values vector is of size 1 (ie, all of the values added have been the same value), and optionally returns what that common value is.

Parameters

pCommon OUT If not nil, receives the common value if there is one, or 0 if there isn't.

Returns: true iff the value vector is of size 1, indicating that there are no mixed values.

virtual bool IPreflightResultRecord::HasSubpart ( ClassID subpartID ) const

pure virtual

Determines whether the given subpart appears in the subpart vector.

Parameters

subpartID IN THe subpart you wish to test for.

Returns: true iff subpartID appears in the subpart vector.

virtual void IPreflightResultRecord::ReadData ( PreflightXferStream & s )

pure virtual

Internal use only. Desrializes the record data from a blob that's stored in the preflight process database.

Parameters

s	IN The serialization stream.

virtual void IPreflightResultRecord::SetAuxString ( const PMString & s )

pure virtual

Sets the aux string, which you can use for other sorting operations where criteria isn't the way you want to sort. For example if you want to store a font name you can put it in here and later present the violations arranged by that.

Note that the IPreflightAggregatedResultsUtils aggregation methods will not aggregate together any entries which have different aux strings.

Parameters

s	IN The new aux string.

virtual void IPreflightResultRecord::SetCriteria ( ClassID criteriaID )

pure virtual

Set the criteria for this record. A criteria ID is normally a way of distinguishing one kind of failure from another. For example the image resolution rule has different criteria IDs for each kind of image (color, gray, b&w). If your rule only has one kind of criteria you don't need to store this; it defaults to kPreflightRC_Default. Since criteria IDs are defined in plugin ID space you can add your own (should, really).

Parameters

criteriaID IN The criteria to set.

virtual void IPreflightResultRecord::SetObjectID ( const PreflightObjectID & objid )

pure virtual

Set the related object ID. This is automatically set up for you if you're using IPreflightVisitInfo::CreateResultRecord().

Parameters

objid IN The object ID to set.

virtual void IPreflightResultRecord::SetProcessNode ( IPreflightProcess::NodeID nodeID )

pure virtual

Set the process node. This generally applies only to the first generation (pre-aggregation) results, since after aggregation there isn't usually a corresponding process database node. Normally you don't set this; the preflight visit info does at creation time.

Parameters

nodeID IN the process node ID.

virtual void IPreflightResultRecord::WriteData ( PreflightXferStream & s ) const

pure virtual

Internal use only. Serializes the record data into a blob that's stored in the preflight process database.

Parameters

s	IN The serialization stream.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation