com.tridion.linking

Class BinaryLink

java.lang.Object

com.tridion.linking.AbstractLink

com.tridion.linking.BinaryLink

public class BinaryLink
extends AbstractLink

The BinaryLink class provides functionality to link to a binary resource based on a tcm:uri. Besides validating that the Binary is available on the Delivery System, it also makes sure that the correct name and path are used to link to existing binaries.

Constructor Summary

Constructors

Constructor and Description
BinaryLink(int publicationId) This constructor instantiates a new BinaryLink object using a publication id.
BinaryLink(String publicationURI) This constructor instantiates a new BinaryLink object using a publication URI.
BinaryLink(String namespace, int publicationId, boolean relativeLink) This constructor instantiates a new BinaryLink object using a publication id and a namespace prefix.

Method Summary

Modifier and Type	Method and Description
Link	getLink(CMURI binaryComponentURI, String variantId) The getLink method tries to find the location of the binary and wraps this location in a Link object.
Link	getLink(String binaryComponentURI, String anchor, String linkText, String linkTagAttributes, boolean showTextOnFail) The getLink method tries to find the location of the binary and wraps this location in a Link object.
Link	getLink(String binaryComponentURI, String variantId, String anchor, String linkText, String linkTagAttributes, boolean showTextOnFail) The getLink method tries to find the location of the binary and wraps this location in a Link object.
Link	getLink(String binaryComponentURI, String variantId, String anchor, String linkText, String binaryUrl, String linkTagAttributes, boolean showTextOnFail)
String	getLinkAsString(String binaryComponentURI, String anchor, String linkText, String linkTagAttributes, boolean showTextOnFail) The getLinkAsString method calls the getLink method to create a link object.
String	getLinkAsString(String binaryComponentURI, String variantId, String anchor, String linkText, String linkTagAttributes, boolean showTextOnFail)
String	getLinkAsString(String binaryComponentURI, String variantId, String anchor, String linkText, String binaryUrl, String linkTagAttributes, boolean showTextOnFail) The getLinkAsString method calls the getLink method to create a link object.

Methods inherited from class com.tridion.linking.AbstractLink

getBaseNamespaceId, getErrorList, getFullyQualifiedURL, getLinking, getNamespace, getNamespaceService, getPublicationId, getURL, isRelativeLink, isWrappedCacheDAO, setPublicationId

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryLink

public BinaryLink(int publicationId)

This constructor instantiates a new BinaryLink object using a publication id. By default tries to resolve links using linking configuration.

Parameters:

publicationId - The id of the publication in which the targeted binary is located.

BinaryLink

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

This constructor instantiates a new BinaryLink object using a publication id and a namespace prefix.

Parameters:

namespace - The namespace of the publication in which the targeted binary is located. tcm or ish

publicationId - The id of the publication in which the targeted binary is located.

relativeLink - If true then the realtive URL will be returned from a Link object despite on linking configuration.

BinaryLink

public BinaryLink(String publicationURI)

This constructor instantiates a new BinaryLink object using a publication URI. By default tries to resolve links using linking configuration.

Parameters:

publicationURI - The uri of the publication in which the targeted binary is located.

Method Detail

getLink

public Link getLink(String binaryComponentURI,
                    String anchor,
                    String linkText,
                    String linkTagAttributes,
                    boolean showTextOnFail)

The getLink method tries to find the location of the binary and wraps this location in a Link object.

Parameters:

binaryComponentURI - The binaryComponentURI of the binary to be linked to.

anchor - The anchor on the page where the link has to be pointing to. Use an empty String or null for this in normal situations.

linkText - The linkText for the link

linkTagAttributes - Attributes to include in the link.

showTextOnFail - Indicated if the linkText parameter should be used if the link does not validate.

Returns:

A link object with a filled in URL if the link was resolved, or with a null-URL if the binary could not be found.

getLink

public Link getLink(CMURI binaryComponentURI,
                    String variantId)

The getLink method tries to find the location of the binary and wraps this location in a Link object.

Parameters:

binaryComponentURI - The binaryComponentURI of the binary to be linked to.

variantId - The id of the variant of the binary to be linked to

Returns:

A link object with a filled in URL if the link was resolved, or with a null-URL if the binary could not be found.

getLink

public Link getLink(String binaryComponentURI,
                    String variantId,
                    String anchor,
                    String linkText,
                    String linkTagAttributes,
                    boolean showTextOnFail)

The getLink method tries to find the location of the binary and wraps this location in a Link object.

Parameters:

binaryComponentURI - The binaryComponentURI of the binary to be linked to.

variantId - The id of the variant of the binary to be linked to

anchor - The anchor on the page where the link has to be pointing to. Use an empty String or null for this in normal situations.

linkText - The linkText for the link

linkTagAttributes - Attributes to include in the link.

showTextOnFail - Indicated if the linkText parameter should be used if the link does not validate.

Returns:

A link object with a filled in URL if the link was resolved, or with a null-URL if the binary could not be found.

getLink

public Link getLink(String binaryComponentURI,
                    String variantId,
                    String anchor,
                    String linkText,
                    String binaryUrl,
                    String linkTagAttributes,
                    boolean showTextOnFail)

getLinkAsString

public String getLinkAsString(String binaryComponentURI,
                              String variantId,
                              String anchor,
                              String linkText,
                              String binaryUrl,
                              String linkTagAttributes,
                              boolean showTextOnFail)

The getLinkAsString method calls the getLink method to create a link object. After this, it calls toString() on this Link-object and returns this as a return value.

Parameters:

binaryComponentURI - The binaryComponentURI of the binary to be linked to.

variantId - The variant id of the binary to be linked to.

anchor - The anchor on the page where the link has to be pointing to. Use an empty String or null for this in normal situations.

linkText - The linkText for the link

linkTagAttributes - Attributes to include in the link.

showTextOnFail - Indicated if the linkText parameter should be used if the link does not resolve or validate.

Returns:

A link in the form of an <a href="...">linkText</a> if the link resolves and validates or, if showTextOnFail is true the linkText if it doesn't and if showTextOnFail is false "".

getLinkAsString

public String getLinkAsString(String binaryComponentURI,
                              String variantId,
                              String anchor,
                              String linkText,
                              String linkTagAttributes,
                              boolean showTextOnFail)

getLinkAsString

public String getLinkAsString(String binaryComponentURI,
                              String anchor,
                              String linkText,
                              String linkTagAttributes,
                              boolean showTextOnFail)

The getLinkAsString method calls the getLink method to create a link object. After this, it calls toString() on this Link-object and returns this as a return value.

Parameters:

binaryComponentURI - The binaryComponentURI of the binary to be linked to.

anchor - The anchor on the page where the link has to be pointing to. Use an empty String or null for this in normal situations.

linkText - The linkText for the link

linkTagAttributes - Attributes to include in the link.

showTextOnFail - Indicated if the linkText parameter should be used if the link does not resolve or validate.

Returns:

A link in the form of an <a href="...">linkText</a> if the link resolves and validates or, if showTextOnFail is true the linkText if it doesn't and if showTextOnFail is false "".