net.dpml.transit
Interface Layout

All Known Implementing Classes:

net.dpml.transit.AbstractLayout, ClassicLayout, EclipseLayout, ModernLayout

public interface Layout

A Layout abstracts the decoding process of the location of artifacts in various filesystems.

Version:

1.0.0

Author:

The Digital Product Meta Library

Method Summary

String	resolveBase(Artifact artifact) Return the base path for an artifact.
String	resolveFilename(Artifact artifact) Return the filename for an artifact.
String	resolvePath(Artifact artifact) Returns the full path of the artifact relative to a logical root directory.

Method Detail

resolveBase

public String resolveBase(Artifact artifact)

Return the base path for an artifact. The base path is the location where the file will be found. The base + "/" filename is equal to the full path.

Parameters:

artifact - the Artifact to resolve.

Returns:

the base path

resolvePath

public String resolvePath(Artifact artifact)

Returns the full path of the artifact relative to a logical root directory. The base + "/" filename is equal to the full path.

Parameters:

artifact - the Artifact to resolve.

Returns:

the logical artifact path

See Also:

resolveBase(net.dpml.transit.Artifact), resolveFilename(net.dpml.transit.Artifact)

resolveFilename

public String resolveFilename(Artifact artifact)

Return the filename for an artifact. The base + "/" filename is equal to the full path.

Parameters:

artifact - the Artifact to resolve.

Returns:

the logical artifact path

See Also:

resolveBase(net.dpml.transit.Artifact), resolveFilename(net.dpml.transit.Artifact)