com.fatwire.assetapi.data

Class DefaultBuildersFactory

java.lang.Object

com.fatwire.assetapi.data.DefaultBuildersFactory

All Implemented Interfaces:

BuildersFactory

@Exported
public class DefaultBuildersFactory
extends Object
implements BuildersFactory

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.commons.logging.Log	log

Constructor Summary

Constructors

Constructor and Description
DefaultBuildersFactory(ICS ics)

Method Summary

Modifier and Type	Method and Description
void	addSessionVariable(String name, String value)
void	addVariable(String name, String value)
AssetId	getAssetId() Get the current asset id in the scope, for ICS, it will get it from c/cid combinations
String	getCookie(String name)
void	logAssetDeps(AssetId... assetIds)
void	logDeps(String... deps)
List<AssetId>	lookUp(String assetType, String assetName, String siteName)
LinkInfo	newAssetLinkInfo()
AssetReader	newAssetReader()
BlobLinkInfo	newBlobLinkInfo()
EditableTemplateFragment<?>	newEditableTemplateFragment() Returns a new EditableTemplateFragment instance.
ElementFragment<?>	newElementFragment() Returns a new ElementFragment instance.
Filter	newFilter(String left, BinaryRelationalOperator operator, String right, String... more) Returns a new Filter which can be used in a search query.
<F extends Fragment> List<F>	newFragmentList() Returns an empty list typed for fragments.
<F extends EditableTemplateFragment<F>> List<EditableTemplateFragment<?>>	newFragmentList(int initialSize, F prototype) Returns a list of the specified size initially filled with fragments based on a prototype fragment.
LegacyLinkInfo	newLegacyAssetLinkInfo()
LegacyBlobLinkInfo	newLegacyBlobLinkInfo()
LinkFactory	newLinkFactory()
NavigationReader	newNavigationReader()
OrderBuilder.OrderChainBuilder<?>	newOrderChain(SortDirection direction, String sortField, String... more) Returns a new OrderBuilder.OrderChainBuilder instance which can be further built upon for creating a list orders for using in a search query.
OrderBuilder.OrderChainBuilder<?>	newOrderChain(String sortField, String... more) Returns a new OrderBuilder.OrderChainBuilder instance which can be further built upon for creating a list orders for using in a search query.
RecommendationReader	newRecommendationReader()
Searcher	newSearcher() Returns a Searcher which can be further built upon for creating a search query.
SiteEntryFragment<?>	newSiteEntryFragment() Returns a new SiteEntryFragment instance.
oracle.fatwire.api.TableReader	newTableReader() Returns a new link TableReader which can be used to query Sites managed tables
TemplateFragment<?>	newTemplateFragment() Returns a new TemplateFragment instance.
void	removeSessionVariable(String name)
void	removeVariable(String name)
void	setCookie(String name, String value, int timeout, String url, String domain, boolean bSecure)

Methods inherited from class java.lang.Object

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

Field Detail

log

public static org.apache.commons.logging.Log log

Constructor Detail

DefaultBuildersFactory

public DefaultBuildersFactory(ICS ics)

Method Detail

getAssetId

public AssetId getAssetId()

Get the current asset id in the scope, for ICS, it will get it from c/cid combinations

Specified by:

getAssetId in interface BuildersFactory

Returns:

the AssetId in the scope

newTableReader

public oracle.fatwire.api.TableReader newTableReader()

Returns a new link TableReader which can be used to query Sites managed tables

Specified by:

newTableReader in interface BuildersFactory

Returns:

a link TableReader instance.

newSearcher

public Searcher newSearcher()

Description copied from interface: BuildersFactory

Returns a Searcher which can be further built upon for creating a search query.

Specified by:

newSearcher in interface BuildersFactory

Returns:

A Searcher instance.

newFilter

public Filter newFilter(String left,
                        BinaryRelationalOperator operator,
                        String right,
                        String... more)

Description copied from interface: BuildersFactory

Returns a new Filter which can be used in a search query. This filter may be used to build more complex filters (see composite Filter instances). Once ready, the filter maybe used in a query by invoking the Searcher filter(Filter) method.

Specified by:

newFilter in interface BuildersFactory

Parameters:

left - left

operator - operator

right - right

more - more

Returns:

A Filter instance. see Filter FilterBuilder Searcher

newOrderChain

public OrderBuilder.OrderChainBuilder<?> newOrderChain(String sortField,
                                                       String... more)

Description copied from interface: BuildersFactory

Returns a new OrderBuilder.OrderChainBuilder instance which can be further built upon for creating a list orders for using in a search query. The Orders instance is obtained by invoking the OrderBuilder.OrderChainBuilder build() method. This Orders instance can then be used in a query by invoking the Searcher orderBy(Orders) method. This method is equivalent to invoking newOrderChain(SortDirection.ASCENDING, String, String...).

Specified by:

newOrderChain in interface BuildersFactory

Parameters:

sortField - sortField

more - more

Returns:

A OrderBuilder.OrderChainBuilder instance.

See Also:

Order Searcher

newOrderChain

public OrderBuilder.OrderChainBuilder<?> newOrderChain(SortDirection direction,
                                                       String sortField,
                                                       String... more)

Description copied from interface: BuildersFactory

Returns a new OrderBuilder.OrderChainBuilder instance which can be further built upon for creating a list orders for using in a search query. The Orders instance is obtained by invoking the OrderBuilder.OrderChainBuilder build() method. This Orders instance can then be used in a query by invoking the Searcher orderBy(Orders) method.

Specified by:

newOrderChain in interface BuildersFactory

Parameters:

direction - direction

sortField - sortField

more - more

Returns:

A OrderBuilder.OrderChainBuilder instance. see Orders Order Searcher

newTemplateFragment

public TemplateFragment<?> newTemplateFragment()

Description copied from interface: BuildersFactory

Returns a new TemplateFragment instance.

Specified by:

newTemplateFragment in interface BuildersFactory

Returns:

A Template fragment.

newEditableTemplateFragment

public EditableTemplateFragment<?> newEditableTemplateFragment()

Description copied from interface: BuildersFactory

Returns a new EditableTemplateFragment instance.

Specified by:

newEditableTemplateFragment in interface BuildersFactory

Returns:

An editable Template fragment.

newSiteEntryFragment

public SiteEntryFragment<?> newSiteEntryFragment()

Description copied from interface: BuildersFactory

Returns a new SiteEntryFragment instance.

Specified by:

newSiteEntryFragment in interface BuildersFactory

Returns:

A SiteEntry fragment.

newElementFragment

public ElementFragment<?> newElementFragment()

Description copied from interface: BuildersFactory

Returns a new ElementFragment instance.

Specified by:

newElementFragment in interface BuildersFactory

Returns:

An Element fragment.

newFragmentList

public <F extends Fragment> List<F> newFragmentList()

Description copied from interface: BuildersFactory

Returns an empty list typed for fragments.

Specified by:

newFragmentList in interface BuildersFactory

Returns:

The empty fragment list.

newFragmentList

public <F extends EditableTemplateFragment<F>> List<EditableTemplateFragment<?>> newFragmentList(int initialSize,
                                                                                                 F prototype)

Description copied from interface: BuildersFactory

Returns a list of the specified size initially filled with fragments based on a prototype fragment. Note: Currently fragment list initialization based on template is only available to implementations of only.

Specified by:

newFragmentList in interface BuildersFactory

Type Parameters:

F - any subclass of Fragment which can be copied any subclass of Fragment which can be copied.

Parameters:

initialSize - the initial size of the list. The template based on which the fragments are created and populated into the list.

prototype - list containing prototyped fragments.

Returns:

The fragment list containing prototyped fragments.

newAssetReader

public AssetReader newAssetReader()

Specified by:

newAssetReader in interface BuildersFactory

newRecommendationReader

public RecommendationReader newRecommendationReader()

Specified by:

newRecommendationReader in interface BuildersFactory

newNavigationReader

public NavigationReader newNavigationReader()

Specified by:

newNavigationReader in interface BuildersFactory

newLinkFactory

public LinkFactory newLinkFactory()

Specified by:

newLinkFactory in interface BuildersFactory

newAssetLinkInfo

public LinkInfo newAssetLinkInfo()

Specified by:

newAssetLinkInfo in interface BuildersFactory

newBlobLinkInfo

public BlobLinkInfo newBlobLinkInfo()

Specified by:

newBlobLinkInfo in interface BuildersFactory

newLegacyAssetLinkInfo

public LegacyLinkInfo newLegacyAssetLinkInfo()

Specified by:

newLegacyAssetLinkInfo in interface BuildersFactory

newLegacyBlobLinkInfo

public LegacyBlobLinkInfo newLegacyBlobLinkInfo()

Specified by:

newLegacyBlobLinkInfo in interface BuildersFactory

logDeps

public void logDeps(String... deps)

Specified by:

logDeps in interface BuildersFactory

logAssetDeps

public void logAssetDeps(AssetId... assetIds)

Specified by:

logAssetDeps in interface BuildersFactory

addSessionVariable

public void addSessionVariable(String name,
                               String value)

Specified by:

addSessionVariable in interface BuildersFactory

removeSessionVariable

public void removeSessionVariable(String name)

Specified by:

removeSessionVariable in interface BuildersFactory

addVariable

public void addVariable(String name,
                        String value)

Specified by:

addVariable in interface BuildersFactory

removeVariable

public void removeVariable(String name)

Specified by:

removeVariable in interface BuildersFactory

setCookie

public void setCookie(String name,
                      String value,
                      int timeout,
                      String url,
                      String domain,
                      boolean bSecure)

Specified by:

setCookie in interface BuildersFactory

getCookie

public String getCookie(String name)

Specified by:

getCookie in interface BuildersFactory

lookUp

public List<AssetId> lookUp(String assetType,
                            String assetName,
                            String siteName)

Specified by:

lookUp in interface BuildersFactory