com.tridion.linking

Class AbstractLink

java.lang.Object

com.tridion.linking.AbstractLink

Direct Known Subclasses:

BinaryLink, ComponentLink, DynamicComponentLink, PageLink

public abstract class AbstractLink
extends Object

The AbstractLink class is an abstract base class for classes implementing linking functionality. This class provides access to a Logger and an ErrorList instance.

Constructor Summary

Constructors

Constructor and Description
AbstractLink(int publicationId) Constructor for the AbstractLink class.
AbstractLink(String publicationURI) Constructor for the AbstractLink class.
AbstractLink(String namespace, int publicationId, boolean relativeLink)

Method Summary

Modifier and Type	Method and Description
Integer	getBaseNamespaceId()
ErrorList	getErrorList() Returns an ErrorList instance.
protected String	getFullyQualifiedURL(String url, String targetURI) Create a full URL based on a partial URL, by including information from the linking configuration file (if specified).
protected Linking	getLinking()
String	getNamespace()
com.tridion.storage.namespace.NamespaceService	getNamespaceService()
protected int	getPublicationId()
protected String	getURL(String targetURL, CMURI targetURI)
protected boolean	isRelativeLink()
protected boolean	isWrappedCacheDAO(com.tridion.storage.dao.BaseDAO baseDAO)
protected void	setPublicationId(int publicationId)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLink

public AbstractLink(int publicationId)

Constructor for the AbstractLink class. Because this class is abstract, it can never be called directly. This constructor can be called by either constructors of inherited classes, or directly when it's not overridden by inherited classes.

Parameters:

publicationId - The id of the publication in which links should be resolved and validated.

AbstractLink

public AbstractLink(String namespace,
                    int publicationId,
                    boolean relativeLink)

AbstractLink

public AbstractLink(String publicationURI)

Constructor for the AbstractLink class. Because this class is abstract, it can never be called directly. This constructor can be called by either constructors of inherited classes, or directly when it's not overridden by inherited classes.

Parameters:

publicationURI - The tcm:uri of the publication in which links should be resolved and validated.

Method Detail

getErrorList

public ErrorList getErrorList()

Returns an ErrorList instance. This list may be filled with Exceptions and error messages by inherited classes.

getNamespaceService

public com.tridion.storage.namespace.NamespaceService getNamespaceService()

getBaseNamespaceId

public Integer getBaseNamespaceId()

getNamespace

public String getNamespace()

getLinking

protected Linking getLinking()

getPublicationId

protected int getPublicationId()

setPublicationId

protected void setPublicationId(int publicationId)

isRelativeLink

protected boolean isRelativeLink()

getURL

protected String getURL(String targetURL,
                        CMURI targetURI)

getFullyQualifiedURL

protected String getFullyQualifiedURL(String url,
                                      String targetURI)

Create a full URL based on a partial URL, by including information from the linking configuration file (if specified).

Parameters:

url - The partial url

targetURI - The URI of the object to look up configuration information for, only the publication id is specified.

Returns:

The input url in case no linking Host configuration is available for the publication of the targetURI (this is the default), or a more specified url with configured protocol, host, port and path.

isWrappedCacheDAO

protected boolean isWrappedCacheDAO(com.tridion.storage.dao.BaseDAO baseDAO)