org.openl.rules.common

Interface ArtefactPath

All Known Implementing Classes:

ArtefactPathImpl

public interface ArtefactPath

Defines path of an Artefact. I.e. location of some particular artefact in a hierarchy of artefacts or in a tree of artefacts.

Author:

Aleh Bykhavets

Method Summary

Modifier and Type	Method and Description
Collection<String>	getSegments() Gets the path as a collection of segments.
String	getStringValue() Gets the path as a single string.
String	getStringValue(int skip) Gets the path as a single string, omitting first skip elements.
String	segment(int index) Gets a segment in the path.
int	segmentCount() Returns number of segments in the path
ArtefactPath	withoutFirstSegment() Create new instance of ArtefactPath from base one, excluding first segment of base path.
ArtefactPath	withoutSegment(int segmentIndex)
ArtefactPath	withSegment(String segment) Creates new instance of ArtefactPath from base one, adding one more segment.

Method Detail

getSegments

Collection<String> getSegments()

Gets the path as a collection of segments.

Returns:

collection of segments

getStringValue

String getStringValue()

Gets the path as a single string. All segments are concatenated by special delimiter '/'.

Returns:

string with the path

getStringValue

String getStringValue(int skip)

Gets the path as a single string, omitting first skip elements. All segments are concatenated by special delimiter '/'.

Parameters:

skip - number of elements to skip

Returns:

string with the path

segment

String segment(int index)

Gets a segment in the path.

Parameters:

index - position of segment in the path

Returns:

value of segment

segmentCount

int segmentCount()

Returns number of segments in the path

Returns:

integer number of segments

withoutFirstSegment

ArtefactPath withoutFirstSegment()

Create new instance of ArtefactPath from base one, excluding first segment of base path.

It is used to translate path of artefact in the workspace to path in a project.

Returns:

new instance where first segment of base path is excluded.

withoutSegment

ArtefactPath withoutSegment(int segmentIndex)

withSegment

ArtefactPath withSegment(String segment)

Creates new instance of ArtefactPath from base one, adding one more segment.

It should be used to build artefact paths recursively.

Parameters:

segment - adding segment

Returns:

new instance where specified segment is appended to path