org.cip4.jdflib.elementwalker

Interface IWalker

All Known Implementing Classes:

AttributeReplacer.WalkAttributeReplacer, AttributeReplacer.WalkDefault, BaseWalker, EnsureElementUri.WalkElement, EnsureNSUri.WalkElement, FixVersion.WalkAncestor, FixVersion.WalkApprovalSuccess, FixVersion.WalkAssembly, FixVersion.WalkAssemblySection, FixVersion.WalkAudit, FixVersion.WalkColor, FixVersion.WalkComment, FixVersion.WalkComponent, FixVersion.WalkCustomerInfo, FixVersion.WalkDevice, FixVersion.WalkElement, FixVersion.WalkEmployee, FixVersion.WalkGeneralID, FixVersion.WalkGeneralIDNamedFeature, FixVersion.WalkJDF, FixVersion.WalkJMF, FixVersion.WalkJMFCommand, FixVersion.WalkJMFCommandAbortQueueEntry, FixVersion.WalkJMFCommandHoldQueueEntry, FixVersion.WalkJMFCommandNewParams, FixVersion.WalkJMFCommandQueueFilter, FixVersion.WalkJMFCommandRemoveQueueEntry, FixVersion.WalkJMFCommandResumeQueueEntry, FixVersion.WalkJMFCommandSuspendQueueEntry, FixVersion.WalkJMFMessage, FixVersion.WalkJMFQuery, FixVersion.WalkJMFResponseAcknowledge, FixVersion.WalkJMFResponseQueue, FixVersion.WalkLayout, FixVersion.WalkLayoutPrep, FixVersion.WalkNodeInfo, FixVersion.WalkPageData, FixVersion.WalkPageList, FixVersion.WalkPool, FixVersion.WalkResLink, FixVersion.WalkResource, FixVersion.WalkSpanBase, FixVersion.WalkState, FixVersion.WalkStrippingParams, FixVersion.WalkTool, IDFinder.WalkResource, IDFinder.WalkSet, LinkRefFinder.WalkRef, RemoveEmpty.WalkComChannel, RemoveEmpty.WalkComment, RemoveEmpty.WalkElement, RemoveEmpty.WalkGeneralID, RemoveEmpty.WalkResource, RemovePrivate.WalkElement, RemovePrivate.WalkGeneralID, RemovePrivate.WalkPrivate, ResourceIDFinder.WalkContinue, ResourceIDFinder.WalkRes, ResourceIDFinder.WalkStop, SizeWalker.WalkElement, UnLinkFinder.WalkRef, UnLinkFinder.WalkRes, URLExtractor.WalkElement, URLExtractor.WalkURL, URLMapper.WalkElement, URLMapper.WalkURL, XJDF20.WalkAudit, XJDF20.WalkAuditPool, XJDF20.WalkColor, XJDF20.WalkColorIntentResLink, XJDF20.WalkColorPoolLink, XJDF20.WalkColorPoolRef, XJDF20.WalkCompany, XJDF20.WalkComponent, XJDF20.WalkContainer, XJDF20.WalkDependencies, XJDF20.WalkDevCap, XJDF20.WalkDevcapElement, XJDF20.WalkDeviceCap, XJDF20.WalkElement, XJDF20.WalkEvaluation, XJDF20.WalkIgnore, XJDF20.WalkInlineAllElement, XJDF20.WalkInlineAllRes, XJDF20.WalkInlineResource, XJDF20.WalkJDF, XJDF20.WalkJDFElement, XJDF20.WalkJMF, XJDF20.WalkLayout, XJDF20.WalkLayoutElement, XJDF20.WalkMediaLink, XJDF20.WalkMediaRefByType, XJDF20.WalkMessage, XJDF20.WalkModifyQueueEntry, XJDF20.WalkPhaseTimeAudit, XJDF20.WalkProduct, XJDF20.WalkRefElement, XJDF20.WalkResLink, XJDF20.WalkResLinkPool, XJDF20.WalkResource, XJDF20.WalkResourceAudit, XJDF20.WalkResourceInfo, XJDF20.WalkRunList, XJDF20.WalkSeparationList, XJDF20.WalkSeparationSpec, XJDF20.WalkSkip, XJDF20.WalkSpan, XJDF20.WalkState, XJDF20.WalkStrippingParams, XJDFSchemaCreator.WalkChildProduct, XJDFSchemaCreator.WalkDependent, XJDFSchemaCreator.WalkDeviceCap, XJDFSchemaCreator.WalkElement, XJDFSchemaCreator.WalkEnumerationType, XJDFSchemaCreator.WalkEvaluation, XJDFSchemaCreator.WalkIgnore, XJDFSchemaCreator.WalkJobPhase, XJDFSchemaCreator.WalkNiCi, XJDFSchemaCreator.WalkNode, XJDFSchemaCreator.WalkProduct, XJDFSchemaCreator.WalkProductList, XJDFSchemaCreator.WalkResource, XJDFSchemaCreator.WalkResourceElement, XJDFSchemaCreator.WalkResourcePhysical, XJDFSchemaCreator.WalkResSet, XJDFSchemaCreator.WalkRoot, XJDFSchemaCreator.WalkState, XJDFSchemaCreator.WalkTerm, XJDFSchemaCreator.WalkTest, XJDFSchemaCreator.WalkTextElement, XJDFSchemaWalker.WalkComplexType, XJDFSchemaWalker.WalkElement, XJDFSchemaWalker.WalkIgnore, XJDFToJDFConverter.WalkChildProduct, XJDFToJDFConverter.WalkColorantControl, XJDFToJDFConverter.WalkColorIntent, XJDFToJDFConverter.WalkCompany, XJDFToJDFConverter.WalkContinue, XJDFToJDFConverter.WalkIgnore, XJDFToJDFConverter.WalkIntent, XJDFToJDFConverter.WalkIntentElement, XJDFToJDFConverter.WalkIntentResource, XJDFToJDFConverter.WalkLayout, XJDFToJDFConverter.WalkLayoutElement, XJDFToJDFConverter.WalkMedia, XJDFToJDFConverter.WalkNodeInfo, XJDFToJDFConverter.WalkProduct, XJDFToJDFConverter.WalkProductList, XJDFToJDFConverter.WalkReplace, XJDFToJDFConverter.WalkResource, XJDFToJDFConverter.WalkRunList, XJDFToJDFConverter.WalkSet, XJDFToJDFConverter.WalkSpan, XJDFToJDFConverter.WalkStrippingParams, XJDFToJDFConverter.WalkXElement, XJDFToJDFConverter.WalkXJDF, XJDFToJDFConverter.WalkXJDFColorResource, XJDFToJDFConverter.WalkXJDFColorSet, XJDFToJDFConverter.WalkXJDFResource, XPathWalker.WalkAll

public interface IWalker

Author:

Rainer Prosi

Method Summary

Methods

Modifier and Type	Method and Description
void	finalizeWalk(KElement e, KElement trackElem) hook for guaranteed postwalk finalization
void	prepareWalk(KElement e, KElement trackElem) hook for guaranteed prewalk initialization
KElement	walk(KElement e, KElement trackElem) called for every IWalker that the factory returns

Method Detail

walk

KElement walk(KElement e,
            KElement trackElem)

called for every IWalker that the factory returns

Parameters:

e - the element to walk

trackElem - a parallel element to e that may additionally be modified during the walk

Returns:

!=null if this element remains after walking,
null if it was deleted and therefore the walker should skip this and all its descendants
the element may either be trackElem or a converted element to continue with as trackElem

prepareWalk

void prepareWalk(KElement e,
               KElement trackElem)

hook for guaranteed prewalk initialization

Parameters:

e - the element to walk

trackElem - a parallel element to e that may additionally be modified during the walk

finalizeWalk

void finalizeWalk(KElement e,
                KElement trackElem)

hook for guaranteed postwalk finalization

Parameters:

e - the element to walk

trackElem - a parallel element to e that may additionally be modified during the walk