ro.sync.exml.workspace.api.util
Interface RelativeReferenceResolver

public interface RelativeReferenceResolver

Control the way in which a relative reference is computed in Oxygen for a given protocol.

Since:

12.1

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Method Summary

java.lang.String

makeRelative(java.net.URL baseURL, java.net.URL childURL) Makes a relative path expressed to the base file from the child.

Method Detail

makeRelative

java.lang.String makeRelative(java.net.URL baseURL,
                              java.net.URL childURL)

Makes a relative path expressed to the base file from the child. If is not possible, the child is returned.

Example of the default implementation: Base: "file://c:/projects/exml/base.prx", Child "file://c:/projects/exml/test/someTest.xml"

Result: "test/someTest.xml"

Parameters:

baseURL - the base URL to report at. Cannot be null

childURL - the child URL. Cannot be null.

Returns:

an relative expression. Return null to use the default implementation.