com.jivesoftware.community.impl
Class BaseContentLinkProvider

java.lang.Object
  com.jivesoftware.community.impl.BaseContentLinkProvider

All Implemented Interfaces:

LinkProvider

public abstract class BaseContentLinkProvider
extends Object
implements LinkProvider

Base implementation of LinkProvider for content types.

Constructor Summary

BaseContentLinkProvider()

Method Summary

boolean	allowsAttachmentLinks() If this object type allows links from other object types to it, this method should return true.
String	getLinkDescriptionFromJiveObject(JiveObject jiveObject) Get the list of macros associated with this object type.
String	getLinkTextFromJiveObject(JiveObject jiveObject) Given a JiveObject, this method should extract the link text for a URL to be generated from the supplied JiveObject.
String	getLinkURLFromJiveObject(JiveObject jiveObject, boolean absolute) Given a JiveObject, this method should construct a relative, or full, URL (depending on the isAbsoluteURL) parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jivesoftware.community.LinkProvider

getAnchorHrefMatcher, getAnchorLinkFromAnchorHrefMatcher, getAttachmentNameFromAnchorHrefMatcher, getLinkCSS, getObjectIdFromAnchorHrefMatcher, parseRelativeURL

Constructor Detail

BaseContentLinkProvider

public BaseContentLinkProvider()

Method Detail

allowsAttachmentLinks

public boolean allowsAttachmentLinks()

Description copied from interface: LinkProvider

 If this object type allows links from other object types to it, this method should return true.

 Primarily consumed by the com.jivesoftware.base.wiki.JiveLinkBuilder class.
 

Specified by:

allowsAttachmentLinks in interface LinkProvider

Returns:

true if this object type allows being linked from other object types.

getLinkTextFromJiveObject

public String getLinkTextFromJiveObject(JiveObject jiveObject)

Description copied from interface: LinkProvider

 Given a JiveObject, this method should extract the link text for a URL to be generated from the supplied JiveObject.

 Primarily consumed by the com.jivesoftware.base.wiki.JiveLinkBuilder class.
 

Specified by:

getLinkTextFromJiveObject in interface LinkProvider

Parameters:

jiveObject - the object to retrieve the link text from

Returns:

the link text for a URL to be generated from the supplied JiveObject

getLinkDescriptionFromJiveObject

public String getLinkDescriptionFromJiveObject(JiveObject jiveObject)

Description copied from interface: LinkProvider

 Get the list of macros associated with this object type.

 Primarily consumed by the com.jivesoftware.base.wiki.JiveLinkBuilder class.
 

Specified by:

getLinkDescriptionFromJiveObject in interface LinkProvider

Parameters:

jiveObject - the object to retrieve the link description from

Returns:

the list of macros associated with this object type

getLinkURLFromJiveObject

public String getLinkURLFromJiveObject(JiveObject jiveObject,
                                       boolean absolute)

Description copied from interface: LinkProvider

 Given a JiveObject, this method should construct a relative, or full, URL (depending on the isAbsoluteURL)
 parameter.

 Primarily consumed by the com.jivesoftware.base.wiki.JiveLinkBuilder class.
 

Specified by:

getLinkURLFromJiveObject in interface LinkProvider

Parameters:

jiveObject - the jive object to retrieve the link url from

absolute - whether or not the url is absolute

Returns:

a relative, or full, URL (depending on the isAbsoluteURL) parameter