org.broadleafcommerce.core.linked.data

Class LinkedDataUtil

java.lang.Object

org.broadleafcommerce.core.linked.data.LinkedDataUtil

public class LinkedDataUtil
extends Object

This class provides a few methods for generating default schema objects that are universal to the entire site.

Author:

Jacob Mitash

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DEFAULT_CONTEXT

Constructor Summary

Constructors

Constructor and Description
LinkedDataUtil()

Method Summary

Modifier and Type	Method and Description
protected static org.codehaus.jettison.json.JSONObject	getDefaultBreadcrumbList(BreadcrumbService breadcrumbService, String url) Generates an object representing the Schema.org BreadcrumbList
protected static org.codehaus.jettison.json.JSONObject	getDefaultOrganization(org.springframework.core.env.Environment environment, String url) Generates an object representing the Schema.org organization
protected static org.codehaus.jettison.json.JSONObject	getDefaultWebSite(org.springframework.core.env.Environment environment, String url) Generates an object representing the Schema.org WebSite
protected static String	getHomepageUrl(String urlFull) Given any full page URL, gets the URL of the homepage
protected static org.codehaus.jettison.json.JSONObject	getLogoObject(org.springframework.core.env.Environment environment) Generates an object representing the Schema.org image for the site logo
protected static org.codehaus.jettison.json.JSONArray	getSocialMediaList() Generates a JSON array of the organization's social media sites

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTEXT

protected static final String DEFAULT_CONTEXT

See Also:

Constant Field Values

Constructor Detail

LinkedDataUtil

public LinkedDataUtil()

Method Detail

getDefaultOrganization

protected static org.codehaus.jettison.json.JSONObject getDefaultOrganization(org.springframework.core.env.Environment environment,
                                                                              String url)
                                                                       throws org.codehaus.jettison.json.JSONException

Generates an object representing the Schema.org organization

Parameters:

url - The URL of the currently visited page

Returns:

JSON representation of Organization from Schema.org

Throws:

org.codehaus.jettison.json.JSONException

getDefaultWebSite

protected static org.codehaus.jettison.json.JSONObject getDefaultWebSite(org.springframework.core.env.Environment environment,
                                                                         String url)
                                                                  throws org.codehaus.jettison.json.JSONException

Generates an object representing the Schema.org WebSite

Parameters:

url - The URL of the currently visited page

Returns:

JSON representation of WebSite from Schema.org

Throws:

org.codehaus.jettison.json.JSONException

getDefaultBreadcrumbList

protected static org.codehaus.jettison.json.JSONObject getDefaultBreadcrumbList(BreadcrumbService breadcrumbService,
                                                                                String url)
                                                                         throws org.codehaus.jettison.json.JSONException

Generates an object representing the Schema.org BreadcrumbList

Parameters:

url - The full URL of the requested page

Returns:

JSON representation of BreadcrumbList from Schema.org

Throws:

org.codehaus.jettison.json.JSONException

getLogoObject

protected static org.codehaus.jettison.json.JSONObject getLogoObject(org.springframework.core.env.Environment environment)
                                                              throws org.codehaus.jettison.json.JSONException

Generates an object representing the Schema.org image for the site logo

Returns:

JSON representation of Schema.org image for site logo

Throws:

org.codehaus.jettison.json.JSONException

getSocialMediaList

protected static org.codehaus.jettison.json.JSONArray getSocialMediaList()
                                                                  throws org.codehaus.jettison.json.JSONException

Generates a JSON array of the organization's social media sites

Returns:

Throws:

org.codehaus.jettison.json.JSONException

getHomepageUrl

protected static String getHomepageUrl(String urlFull)

Given any full page URL, gets the URL of the homepage

Parameters:

urlFull - the full URL of any page on the site

Returns:

the URL of the homepage of the site