com.tridion.dcp

Class ComponentPresentationFactory

java.lang.Object

com.tridion.dcp.ComponentPresentationFactory

public class ComponentPresentationFactory
extends Object

Class used to retrieve the raw content of component presentations.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL ALL.
static int	ASP ASP.
static int	HTML HTML.
static int	JSP JSP.
static int	TEXT TEXT.
static int	XML XML.

Constructor Summary

Constructors

Constructor and Description
ComponentPresentationFactory(int publicationId) Constructor for a new component presentation factory object.
ComponentPresentationFactory(String itemURI) Constructor for a new component presentation factory object.

Method Summary

Modifier and Type	Method and Description
Collection<ComponentPresentation>	findAllComponentPresentations(int componentId) Retrieve a list of all component presentations for a component.
Collection<ComponentPresentation>	findAllComponentPresentations(int thePublicationId, int componentId) Retrieve a list of all component presentations for a component.
Collection<ComponentPresentation>	findAllComponentPresentations(String componentURI) Retrieve a list of all component presentations for a component.
ComponentPresentation	getComponentPresentation(int componentId, int templateId) Get a component presentation.
ComponentPresentation	getComponentPresentation(int thePublicationId, int componentId, int templateId) Get a component presentation.
protected ComponentPresentation	getComponentPresentation(int thePublicationId, int componentId, int templateId, String type, String encoding)
ComponentPresentation	getComponentPresentation(String componentURI, String templateURI) Get a component presentation.
ComponentPresentation	getComponentPresentationWithHighestPriority(int componentId) Get the component presentation for a component that has the highest priority.
ComponentPresentation	getComponentPresentationWithHighestPriority(String componentURI) Get the component presentation for a component that has the highest priority.
ComponentPresentation	getComponentPresentationWithLowestPriority(int componentId) Get the component presentation for a component that has the lowest priority.
ComponentPresentation	getComponentPresentationWithLowestPriority(String componentURI) Get the component presentation for a component that has the lowest priority.
ComponentPresentation	getComponentPresentationWithOutputFormat(int componentId, String formatString) Get a component presentation for a component, with the given output format.
ComponentPresentation	getComponentPresentationWithOutputFormat(String componentURI, String formatString) Get a component presentation for a component, with the given output format.
ComponentPresentation	getComponentPresentationWithPriority(int componentId, int priority) Get a component presentation for a component, with the specified priority.
ComponentPresentation	getComponentPresentationWithPriority(String componentURI, int templatePriority) Get a component presentation for a component, with the specified priority.
ComponentPresentation[]	getTaxonomyComponentPresentations(Keyword[] taxonomyKeywords, String templateURI, boolean includeBranchedKeywords) This retrieves all ComponentPresentations for the specified taxonomy keyword, either directly linked to the keyword or a branch/child of the specified keyword.
ComponentPresentation[]	getTaxonomyComponentPresentations(Keyword taxonomyKeyword, String templateURI, boolean includeBranchedKeywords) This retrieves all ComponentPresentations for the specified taxonomy keyword, either directly linked to the keyword or a branch/child of the specified keyword.
Keyword[]	getTaxonomyKeywords(String[] componentURIs, Keyword[] contextKeywords, TaxonomyFilter taxonomyFilter) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.
Keyword[]	getTaxonomyKeywords(String componentURI, Keyword[] contextKeywords, TaxonomyFilter taxonomyFilter) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.
Keyword[]	getTaxonomyKeywords(String taxonomyURI, String[] componentURIs, Keyword[] contextKeywords, TaxonomyFilter taxonomyFilter) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.
Keyword[]	getTaxonomyKeywords(String taxonomyURI, String componentURI, Keyword[] contextKeywords, TaxonomyFilter taxonomyFilter) Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Methods inherited from class java.lang.Object

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

Field Detail

HTML

public static final int HTML

HTML.

See Also:

Constant Field Values

XML

public static final int XML

XML.

See Also:

Constant Field Values

JSP

public static final int JSP

JSP.

See Also:

Constant Field Values

ASP

public static final int ASP

ASP.

See Also:

Constant Field Values

TEXT

public static final int TEXT

TEXT.

See Also:

Constant Field Values

ALL

public static final int ALL

ALL.

See Also:

Constant Field Values

Constructor Detail

ComponentPresentationFactory

public ComponentPresentationFactory(String itemURI)

Constructor for a new component presentation factory object.

Parameters:

itemURI - A URI of an item in the publication the object should be created for.

ComponentPresentationFactory

public ComponentPresentationFactory(int publicationId)

Constructor for a new component presentation factory object.

Parameters:

publicationId - The id of the publication to create this object for.

Method Detail

getComponentPresentation

public ComponentPresentation getComponentPresentation(int componentId,
                                                      int templateId)

Get a component presentation.

Parameters:

componentId - The component of the component presentation.

templateId - The template of the component presentation.

Returns:

The matching component presentation, or null if the component presentation could not be found.

getComponentPresentation

public ComponentPresentation getComponentPresentation(String componentURI,
                                                      String templateURI)

Get a component presentation.

Parameters:

componentURI - The TCM URI of the component in the component presentation.

templateURI - The TCM URI of the template in the component presentation.

Returns:

The matching component presentation, or null if the component presentation could not be found.

getTaxonomyComponentPresentations

public ComponentPresentation[] getTaxonomyComponentPresentations(Keyword taxonomyKeyword,
                                                                 String templateURI,
                                                                 boolean includeBranchedKeywords)
                                                          throws StorageException

This retrieves all ComponentPresentations for the specified taxonomy keyword, either directly linked to the keyword or a branch/child of the specified keyword.

Parameters:

taxonomyKeyword - The taxonomy keyword the ComponentPresentation must be related to

templateURI - The templateURI of the ComponentPresentations

includeBranchedKeywords - True if all the childKeywords of the specified facet should be included

Returns:

A list of ComponentPresentations, empty list if nothing was found

Throws:

StorageException - If unable to retrieve ComponentPresentations for keyword

getTaxonomyComponentPresentations

public ComponentPresentation[] getTaxonomyComponentPresentations(Keyword[] taxonomyKeywords,
                                                                 String templateURI,
                                                                 boolean includeBranchedKeywords)
                                                          throws StorageException

This retrieves all ComponentPresentations for the specified taxonomy keyword, either directly linked to the keyword or a branch/child of the specified keyword.

Parameters:

taxonomyKeywords - The combined taxonomy keywords the ComponentPresentation must be related to

templateURI - The templateURI of the ComponentPresentations

includeBranchedKeywords - True if all the childKeywords of the specified facet should be included

Returns:

A list of ComponentPresentations, empty list if nothing was found

Throws:

StorageException - If unable to retrieve ComponentPresentations for keyword

getTaxonomyKeywords

public Keyword[] getTaxonomyKeywords(String componentURI,
                                     Keyword[] contextKeywords,
                                     TaxonomyFilter taxonomyFilter)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

componentURI - THe URI of the content to search keywords for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

taxonomyFilter - The filter to apply to the found keywords

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getTaxonomyKeywords

public Keyword[] getTaxonomyKeywords(String[] componentURIs,
                                     Keyword[] contextKeywords,
                                     TaxonomyFilter taxonomyFilter)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

componentURIs - THe URIs of the content to search keywords for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

taxonomyFilter - The filter to apply to the found keywords

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getTaxonomyKeywords

public Keyword[] getTaxonomyKeywords(String taxonomyURI,
                                     String componentURI,
                                     Keyword[] contextKeywords,
                                     TaxonomyFilter taxonomyFilter)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

taxonomyURI - The URI of the Taxonomy

componentURI - THe URI of the content to search keywords for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

taxonomyFilter - The filter to apply to the found keywords

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getTaxonomyKeywords

public Keyword[] getTaxonomyKeywords(String taxonomyURI,
                                     String[] componentURIs,
                                     Keyword[] contextKeywords,
                                     TaxonomyFilter taxonomyFilter)

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

Parameters:

taxonomyURI - The URI of the Taxonomy, may be null if no specific taxonomy is required

componentURIs - THe URIs of the content to search keywords for

contextKeywords - The URIs of already selected context keywords, this will be used to retrieve related items.

taxonomyFilter - The filter to apply to the found keywords

Returns:

An array of found Keywords, a merged keyword array without duplicates.

getComponentPresentation

public ComponentPresentation getComponentPresentation(int thePublicationId,
                                                      int componentId,
                                                      int templateId)

Get a component presentation.

Parameters:

thePublicationId - The publication the component presentation is in.

componentId - The component of the component presentation.

templateId - The template of the component presentation.

Returns:

The matching component presentation, or null if the component presentation could not be found.

getComponentPresentationWithHighestPriority

public ComponentPresentation getComponentPresentationWithHighestPriority(int componentId)

Get the component presentation for a component that has the highest priority.

(Note: The results of this method are currently not cached)

Parameters:

componentId - The component to get a component presentation for.

Returns:

The matching component presentation, or null if no component presentation for the component could be found.

getComponentPresentationWithHighestPriority

public ComponentPresentation getComponentPresentationWithHighestPriority(String componentURI)

Get the component presentation for a component that has the highest priority.

(Note: The results of this method are currently not cached)

Parameters:

componentURI - The component to get a component presentation for.

Returns:

The matching component presentation, or null if no component presentation for the component could be found.

getComponentPresentationWithLowestPriority

public ComponentPresentation getComponentPresentationWithLowestPriority(int componentId)

Get the component presentation for a component that has the lowest priority.

(Note: The results of this method are currently not cached)

Parameters:

componentId - The component to get a component presentation for.

Returns:

The matching component presentation, or null if no component presentation for the component could be found.

getComponentPresentationWithLowestPriority

public ComponentPresentation getComponentPresentationWithLowestPriority(String componentURI)

Get the component presentation for a component that has the lowest priority.

(Note: The results of this method are currently not cached)

Parameters:

componentURI - The TCM URI of the component to get a component presentation for.

Returns:

The matching component presentation, or null if no component presentation for the component could be found.

getComponentPresentationWithPriority

public ComponentPresentation getComponentPresentationWithPriority(int componentId,
                                                                  int priority)

Get a component presentation for a component, with the specified priority.

(Note: The results of this method are currently not cached)

Parameters:

componentId - The component to get a component presentation for.

priority - The priority of the to be found component presentation.

Returns:

A matching component presentation, or null if no match could be found.

getComponentPresentationWithPriority

public ComponentPresentation getComponentPresentationWithPriority(String componentURI,
                                                                  int templatePriority)

Get a component presentation for a component, with the specified priority.

(Note: The results of this method are currently not cached)

Parameters:

componentURI - The TCM URI of the component to get a component presentation for.

templatePriority - The priority of the to be found component presentation.

Returns:

A matching component presentation, or null if no match could be found.

getComponentPresentationWithOutputFormat

public ComponentPresentation getComponentPresentationWithOutputFormat(int componentId,
                                                                      String formatString)

Get a component presentation for a component, with the given output format.

(Note: The results of this method are currently not cached)

Parameters:

componentId - The component to find a component presentation for.

formatString - The output format the component presentation should have.

Returns:

A matching component presentation, or null if no match could be found.

getComponentPresentationWithOutputFormat

public ComponentPresentation getComponentPresentationWithOutputFormat(String componentURI,
                                                                      String formatString)

Get a component presentation for a component, with the given output format.

(Note: The results of this method are currently not cached)

Parameters:

componentURI - The TCM URI of the component to find a component presentation for.

formatString - The output format the component presentation should have.

Returns:

A matching component presentation, or null if no match could be found.

getComponentPresentation

protected ComponentPresentation getComponentPresentation(int thePublicationId,
                                                         int componentId,
                                                         int templateId,
                                                         String type,
                                                         String encoding)

findAllComponentPresentations

public Collection<ComponentPresentation> findAllComponentPresentations(int componentId)

Retrieve a list of all component presentations for a component.

(Note: The results of this method are currently not cached)

Parameters:

componentId - The component to find

Returns:

A list of found component presentations.

findAllComponentPresentations

public Collection<ComponentPresentation> findAllComponentPresentations(int thePublicationId,
                                                                       int componentId)

Retrieve a list of all component presentations for a component.

(Note: The results of this method are currently not cached)

Parameters:

componentId - The component to find

thePublicationId - The Publication ID to find the components for

Returns:

A list of found component presentations.

findAllComponentPresentations

public Collection<ComponentPresentation> findAllComponentPresentations(String componentURI)

Retrieve a list of all component presentations for a component.

(Note: The results of this method are currently not cached)

Parameters:

componentURI - The TCM URI of the relevant component

Returns:

A list of found component presentations.