IPreflightAggregatedResultsUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Matt Phillips
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================


#include "IPMUnknown.h"
#include "PackageAndPreflightID.h"
#include "Utils.h"
#include "IPreflightAggregatedResults.h"
#include "IPreflightProcess.h"

class IPreflightResultRecordTable;
class IPreflightResultRecord;
class IPreflightResultNodeData;
class IPreflightResultNodeInfo;

class IPreflightAggregatedResultsUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPREFLIGHTAGGREGATEDRESULTSUTILS };

public:
 typedef InterfacePtr<IPreflightResultRecordTable> ResultTableIFP;
 typedef K2Vector<ResultTableIFP> VectorOfTables;
 typedef K2Vector<int32> VectorOfIndices;

 enum
 {
 kAggregateDifferentSubparts = (1L<<0),

 kAggregateTextRangesWithDifferentValues = (1L<<1),

 kAggregateCellsWithDifferentValues = (1L<<2),

 kDoNotAggregateSingluarValueSubparts = (1L<<3)
 };

public:
 virtual IPreflightAggregatedResults* CreateAggregatedResults() const = 0;

 virtual IPreflightResultRecord* CreatePreflightResultRecord() const = 0;

 virtual IPreflightResultRecordTable* CreatePreflightResultRecordTable() const = 0;

 virtual IPreflightResultNodeInfo* CreatePreflightResultNodeInfo() const = 0;

 virtual IPreflightResultRecordTable* CreateTableFromNodes
 (
 const IPreflightProcess* iProcess, 
 const IPreflightProcess::NodeIDVector& resultNodes
 ) const = 0;

 virtual const IPreflightResultRecordTable* ApplyAllStandardAggregations
 (
 const IPreflightProcess* iProcess, 
 const IPreflightResultRecordTable* iTable,
 uint32 aggregationFlags = 0
 ) const = 0;

 virtual const IPreflightResultRecordTable* AggregateMarkingOperationsToUsefulObjects
 (
 const IPreflightProcess* iProcess, 
 const IPreflightResultRecordTable* iTable,
 uint32 aggregationFlags = 0
 ) const = 0;

 virtual const IPreflightResultRecordTable* AggregateContiguousTextRanges
 (
 const IPreflightResultRecordTable* iTable,
 uint32 aggregationFlags = 0
 ) const = 0;

 virtual const IPreflightResultRecordTable* AggregateContiguousCells
 (
 const IPreflightResultRecordTable* iTable,
 bool horizontally,
 uint32 aggregationFlags
 ) const = 0;

 virtual const IPreflightResultRecordTable* AggregateDifferentSubpartsSameEverythingElse
 (
 const IPreflightResultRecordTable* iTable,
 uint32 aggregationFlags = 0
 ) const = 0;

 virtual const IPreflightResultRecordTable* CreateSubTable
 (
 const IPreflightResultRecordTable* iSrcTable,
 const VectorOfIndices& indices
 ) const = 0;

 virtual IPreflightResultRecordTable* CreateSubTableByCriteria
 (
 const IPreflightResultRecordTable* iSrc, 
 ClassID criteriaID,
 bool invertCriteria = kFalse
 ) const = 0;

 virtual void CreateTablesByCriteria
 (
 const IPreflightResultRecordTable* iSrcTable,
 VectorOfTables& tables
 ) const = 0;

 virtual void CreateTablesByAuxString
 (
 const IPreflightResultRecordTable* iSrcTable,
 VectorOfTables& tables
 ) const = 0;

 virtual void CreateTablesByObject
 (
 const IPreflightResultRecordTable* iSrcTable,
 VectorOfTables& tables
 ) const = 0;
 
 virtual bool IsPlacedContent(const IPreflightResultRecord* iRec) const = 0;

 virtual PMString FormatXMeasure(const IPreflightProcess* iProcess, const PMReal& x) const = 0;

 virtual PMString FormatYMeasure(const IPreflightProcess* iProcess, const PMReal& y) const = 0;

 virtual PMString FormatLineMeasure(const IPreflightProcess* iProcess, const PMReal& x) const = 0;

 virtual PMString FormatTextSizeMeasure(const IPreflightProcess* iProcess, const PMReal& x) const = 0;

 virtual PMString FormatResolution(const PMReal& x) const = 0;

 virtual PMString FormatAsInteger(const PMReal& x) const = 0;

 virtual PMString GetSubpartsDescription
 (
 const IPreflightResultRecord* iRec, 
 bool forceTranslation = kTrue
 ) const = 0;

 virtual IPreflightAggregatedResults::NodeID AddCriteriaNode
 (
 IPreflightAggregatedResults* iResults, 
 IPreflightAggregatedResults::NodeID parentID, 
 const PMString& nodeText,
 const PreflightRuleID& ruleID
 ) const = 0;

 virtual IPreflightResultNodeInfo* CreateViolationNode
 (
 const PreflightObjectID& objID
 ) const = 0;

 virtual IPreflightResultNodeInfo* CreateCriteriaAndViolationNode
 (
 const PreflightObjectID& objID,
 const PMString& nodeName,
 const PreflightRuleID& ruleID
 ) const = 0;

 virtual IPreflightResultNodeInfo* CreateGenericNode
 (
 const PMString& nodeName,
 const PreflightRuleID& ruleID
 ) const = 0;

 virtual IPreflightAggregatedResults::NodeID AddResultsNode
 (
 IPreflightAggregatedResults* iResults, 
 IPreflightAggregatedResults::NodeID parentID, 
 IPreflightResultNodeInfo* iInfo
 ) const = 0;

 virtual void AddProxyCriteriaAndNodes
 (
 IPreflightAggregatedResults* iResults, 
 IPreflightAggregatedResults::NodeID parentID, 
 const IPreflightResultRecordTable* iProxyTable, 
 const PMString& criteriaName,
 const PreflightRuleID& ruleID
 ) const = 0;
};