net.sf.okapi.lib.xliff2.walker

Class XliffWalker

java.lang.Object

net.sf.okapi.lib.xliff2.walker.XliffWalker

public class XliffWalker
extends Object

Allows for traversal of the tree structure of an XLIFF document, in a fashion similar to visitor pattern. Three types of visitor can be added to the XliffWalker: File visitors, Unit visitors, and Segment visitors. The exact order in which the visit() method of those visitors is called is determined by the IXliffWalkerStrategy, for which a default implementation, flexible implementation and ordered pipeline implementations are provided.

Author:

Martin Wunderlich, Vladyslav Mykhalets

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XliffWalker.VisitPlaceAwareXliffVisitor<T> Xliff visitor IXliffVisitor decorator class aware of visit place defined by path selector XliffWalkerPathSelector

Constructor Summary

Constructors

Constructor and Description
XliffWalker()
XliffWalker(IXliffWalkerStrategy strategy)

Method Summary

Modifier and Type	Method and Description
String	addFileVisitor(IXliffVisitor<FileNode> visitor, XliffWalkerPathSelector... pathSelectors)
String	addFileVisitor(XliffWalker.VisitPlaceAwareXliffVisitor<FileNode> visitor)
String	addSegmentVisitor(IXliffVisitor<Segment> visitor, XliffWalkerPathSelector... pathSelectors)
String	addSegmentVisitor(XliffWalker.VisitPlaceAwareXliffVisitor<Segment> visitor)
String	addUnitVisitor(IXliffVisitor<UnitNode> visitor, XliffWalkerPathSelector... pathSelectors)
String	addUnitVisitor(XliffWalker.VisitPlaceAwareXliffVisitor<UnitNode> visitor)
void	doWalk(XLIFFDocument xlf) Main method for running the traversal.
List<IXliffVisitor<FileNode>>	getAllFileNodeVisitors()
List<IXliffVisitor<Segment>>	getAllSegmentVisitors()
List<IXliffVisitor<UnitNode>>	getAllUnitNodeVisitors()
List<IXliffVisitor<FileNode>>	getFileNodeVisitors(String fileId) Method returns visitors which are configured to be executed on specific file id.
XliffWalker.VisitPlaceAwareXliffVisitor<FileNode>	getFileVisitor(String id) Method returns XliffWalker.VisitPlaceAwareXliffVisitor for FileNode by its id.
XliffWalker.VisitPlaceAwareXliffVisitor<Segment>	getSegmentVisitor(String id) Method returns XliffWalker.VisitPlaceAwareXliffVisitor for Segment by its id.
List<IXliffVisitor<Segment>>	getSegmentVisitors(String fileId, String unitId, int segmentIndex) Method returns visitors which are configured to be executed on specific file id, unit id and segment index.
List<IXliffVisitor<UnitNode>>	getUnitNodeVisitors(String fileId, String unitId) Method returns visitors which are configured to be executed on specific file id and unit id.
XliffWalker.VisitPlaceAwareXliffVisitor<UnitNode>	getUnitVisitor(String id) Method returns XliffWalker.VisitPlaceAwareXliffVisitor for UnitNode by its id.
int	getVisitorCount()
void	removeFileVisitor(String id)
void	removeSegmentVisitor(String id)
void	removeUnitVisitor(String id)
void	removeVisitors()
void	setVisitors(List<IXliffVisitor<FileNode>> fileVisitors, List<IXliffVisitor<UnitNode>> unitVisitors, List<IXliffVisitor<Segment>> segmentVisitors)
Iterator<String>	visitorsIterator()

Methods inherited from class java.lang.Object

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

Constructor Detail

XliffWalker

public XliffWalker()

XliffWalker

public XliffWalker(IXliffWalkerStrategy strategy)

Method Detail

doWalk

public void doWalk(XLIFFDocument xlf)

Main method for running the traversal. Should only be called after some visitors have been added to the Walker. Otherwise, an exception will be thrown.

visitorsIterator

public Iterator<String> visitorsIterator()

setVisitors

public void setVisitors(List<IXliffVisitor<FileNode>> fileVisitors,
                        List<IXliffVisitor<UnitNode>> unitVisitors,
                        List<IXliffVisitor<Segment>> segmentVisitors)

removeFileVisitor

public void removeFileVisitor(String id)

removeUnitVisitor

public void removeUnitVisitor(String id)

removeSegmentVisitor

public void removeSegmentVisitor(String id)

getVisitorCount

public int getVisitorCount()

getFileVisitor

public XliffWalker.VisitPlaceAwareXliffVisitor<FileNode> getFileVisitor(String id)

Method returns XliffWalker.VisitPlaceAwareXliffVisitor for FileNode by its id.

Parameters:

id - id of the visitor

Returns:

instance of XliffWalker.VisitPlaceAwareXliffVisitor for FileNode

getUnitVisitor

public XliffWalker.VisitPlaceAwareXliffVisitor<UnitNode> getUnitVisitor(String id)

Method returns XliffWalker.VisitPlaceAwareXliffVisitor for UnitNode by its id.

Parameters:

id - id of the visitor

Returns:

instance of XliffWalker.VisitPlaceAwareXliffVisitor for UnitNode

getSegmentVisitor

public XliffWalker.VisitPlaceAwareXliffVisitor<Segment> getSegmentVisitor(String id)

Method returns XliffWalker.VisitPlaceAwareXliffVisitor for Segment by its id.

Parameters:

id - id of the visitor

Returns:

instance of XliffWalker.VisitPlaceAwareXliffVisitor for Segment

getFileNodeVisitors

public List<IXliffVisitor<FileNode>> getFileNodeVisitors(String fileId)

Method returns visitors which are configured to be executed on specific file id.

Parameters:

fileId - file node id

Returns:

list of IXliffVisitor for FileNode

getUnitNodeVisitors

public List<IXliffVisitor<UnitNode>> getUnitNodeVisitors(String fileId,
                                                         String unitId)

Method returns visitors which are configured to be executed on specific file id and unit id.

Parameters:

fileId - file node id

unitId - unit node id

Returns:

list of IXliffVisitor for UnitNode

getSegmentVisitors

public List<IXliffVisitor<Segment>> getSegmentVisitors(String fileId,
                                                       String unitId,
                                                       int segmentIndex)

Method returns visitors which are configured to be executed on specific file id, unit id and segment index.

Parameters:

fileId - file node id

unitId - unit node id

segmentIndex - segment index

Returns:

list of IXliffVisitor for Segment

getAllFileNodeVisitors

public List<IXliffVisitor<FileNode>> getAllFileNodeVisitors()

getAllUnitNodeVisitors

public List<IXliffVisitor<UnitNode>> getAllUnitNodeVisitors()

getAllSegmentVisitors

public List<IXliffVisitor<Segment>> getAllSegmentVisitors()

addFileVisitor

public String addFileVisitor(XliffWalker.VisitPlaceAwareXliffVisitor<FileNode> visitor)

addFileVisitor

public String addFileVisitor(IXliffVisitor<FileNode> visitor,
                             XliffWalkerPathSelector... pathSelectors)

addUnitVisitor

public String addUnitVisitor(XliffWalker.VisitPlaceAwareXliffVisitor<UnitNode> visitor)

addUnitVisitor

public String addUnitVisitor(IXliffVisitor<UnitNode> visitor,
                             XliffWalkerPathSelector... pathSelectors)

addSegmentVisitor

public String addSegmentVisitor(XliffWalker.VisitPlaceAwareXliffVisitor<Segment> visitor)

addSegmentVisitor

public String addSegmentVisitor(IXliffVisitor<Segment> visitor,
                                XliffWalkerPathSelector... pathSelectors)

removeVisitors

public void removeVisitors()