com.neurosys.content.dao

Interface ContentSource<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>

Type Parameters:

C - as Content type

All Superinterfaces:

FreeQuery, GenericDao<C>

All Known Subinterfaces:

CommentDao, HierarchyContentSource<C,CA,CF>, PostDao

All Known Implementing Classes:

AbstractContentHierarchyDaoImpl, CommentDaoImpl, ContentDaoImpl, PostDaoImpl

public interface ContentSource<C extends Content<CA,CF>,CA extends AbstractContentAttribute,CF extends AbstractContentFacet>
extends GenericDao<C>

Defines a Content Source

Author:

Arjun Dhar

Method Summary

Modifier and Type	Method and Description
Long	count(Query<C> query) See Implementation/Implementing Source Adapter for more details on how to construct the query.
int	deleteContent(String name, boolean deleteChildren) Delete a content and all associated content for all locales etc.
int	deleteFacet(Long id)
int	deleteFacet(String name) Delete a ContentFacet
int	deleteFacet(String name, Integer index) Delete a ContentFacet @ the index position
C	getContent(String name, Locale locale, Status status) Get content for Default name and specified locale and Status
Map<Locale,Map<Status,C>>	getContents(String name) Get Content for all the locales this content exists for.
Map<Status,C>	getContents(String name, Locale locale) Get content for specified name and locale.
List<C>	getContentsList(String name) Get contents across Status, Locales etc.
List<CF>	getFacetArray(Long contentId, String facetName, Collection<Integer> indeces) Fetch specific facets in order of their natural index.
List<Integer>	getFacetArrayIndeces(Long contentId, String facetName) The indeces is guaranteed to be in order of its index position which can be any positive, 0 or negative number even.
List<CF>	getFacets(C proxyContentQueryObject, String facetName) Fetch a particular content for a AbstractContent query object; where based on how specific the details within the AbstractContent object are it will return the result.
Collection<CF>	getFacets(Long contentId)
Collection<CF>	getFacets(Query<CF> qry) To keep payload minimal and to support most use case scenarios, the Impl may want to lazy load the facets in the C on explicit request. This method allows that explicit request to be fullfilled.
Page<C>	loadPage(Query<C> query) See Implementation/Implementing Source Adapter for more details on how to construct the query.
C	publish(C content) Clone Preview C record (& related ContentFacets, attributes) to publish
void	publish(Collection<C> contents) Clone Preview C record(s) (& related ContentFacets, attributes) to publish
List<C>	query(Query<C> query) Execute Query and on Queryable fields only.
Page<C>	queryPage(Query<C> query) Execute Query and on Queryable fields only.
CF	saveFacet(CF cf) Save a Facet
C	setContent(C content)
void	unPublish(C content) Delete published version from source.
void	updateContentMetaAll(C content, String[] selectedAttribs) Will update the aspects of C displayName, attributes & Bit mask across all copies of the Content(for each Status), but not across languages
void	updateContentName(String oldName, String newName) Update C#setName(String)
int	updateContentStatus(String name, Locale locale, Status oldStatus, Status newStatus) This will cause an update to the Content state.

Methods inherited from interface com.neurosys.dao.GenericDao

delete, delete, load, load, save

Methods inherited from interface com.neurosys.dao.FreeQuery

query, query, update

Method Detail

loadPage

Page<C> loadPage(Query<C> query)

See Implementation/Implementing Source Adapter for more details on how to construct the query.

Parameters:

query - as Query for C

Returns:

of C

See Also:

this#reloadFacets(C)}

count

Long count(Query<C> query)

See Implementation/Implementing Source Adapter for more details on how to construct the query.

Parameters:

query - as Query for C

Returns:

of C

See Also:

this#reloadFacets(C)}

getContent

C getContent(String name,
             Locale locale,
             Status status)

Get content for Default name and specified locale and Status

Parameters:

name - as the identifier of Content

locale - as Locale

status - as Status

Returns:

C

See Also:

this#reloadFacets(C)}

getContents

Map<Status,C> getContents(String name,
                          Locale locale)

Get content for specified name and locale. The content can exists in multiple Status.

Parameters:

name - as the identifier of Content

Returns:

Map of Status , C

See Also:

this#reloadFacets(C)}

getContents

Map<Locale,Map<Status,C>> getContents(String name)

Get Content for all the locales this content exists for.

Parameters:

name - identifier of Content

locale - for the locales @nullable true

Returns:

Map of ( locale, Map of (Status, C) )

See Also:

this#reloadFacets(C)}

getContentsList

List<C> getContentsList(String name)

Get contents across Status, Locales etc. for a given unique (across locale & Status) NameId

Parameters:

name -

Returns:

setContent

C setContent(C content)

Parameters:

content - as C

See Also:

this#reloadFacets(C)} also

getFacets

Collection<CF> getFacets(Query<CF> qry)

To keep payload minimal and to support most use case scenarios, the Impl may want to lazy load the facets in the C on explicit request.
This method allows that explicit request to be fullfilled.

Parameters:

qry -

getFacetArray

List<CF> getFacetArray(Long contentId,
                       String facetName,
                       Collection<Integer> indeces)

Fetch specific facets in order of their natural index. The index is an integer. The array is guaranteed to be in order of its index position which can be any positive, 0 or negative number even.

Parameters:

contentId - as Long

facetName - as String

indeces - as optional (Nullable), List of index numbers to fetch. If null will netch all.

Returns:

List of ContentFacet

getFacetArrayIndeces

List<Integer> getFacetArrayIndeces(Long contentId,
                                   String facetName)

The indeces is guaranteed to be in order of its index position which can be any positive, 0 or negative number even.

Parameters:

contentId - as Long

facetName - as String

Returns:

List of Integers to indicate index position (inc null)

getFacets

Collection<CF> getFacets(Long contentId)

Parameters:

contentId - as Long

Returns:

collection of ContentFacet

getFacets

List<CF> getFacets(C proxyContentQueryObject,
                   String facetName)

Fetch a particular content for a AbstractContent query object; where based on how specific the details within the AbstractContent object are it will return the result.

Note: For most specific case also it may return a List as AbstractContentFacet support arrays and for the same facet name, there can be multiple AbstractContentFacets for the same AbstractContent.

Parameters:

contentName - as String

facetName - as String

Returns:

ContentFacet type

deleteContent

int deleteContent(String name,
                  boolean deleteChildren)

Delete a content and all associated content for all locales etc.
sub-hierarchy Deletion is optional as a flag, however most cases it makes sense to provide true as it makes no sense to have dangling orphaned children. However keeping in mind, complex scenarios and intermediate situations that can arise this feature is supported as a service level call.

Parameters:

name - of Content as String

deleteChildren - as boolean; will delete sub-hierarchy to this content

Returns:

int as the number of content records deleted (related records like ContentAttribute, ContentFacet etc are not counted, just core content entity objects)

deleteFacet

int deleteFacet(String name)

Delete a ContentFacet

Parameters:

name - as String

Returns:

int as number of records deleted. If the facet is an array more than 1 record will be delted

deleteFacet

int deleteFacet(Long id)

deleteFacet

int deleteFacet(String name,
                Integer index)

Delete a ContentFacet @ the index position

Parameters:

name - as String

index - as Integer (@Nullable)

Returns:

int as number of records deleted

updateContentStatus

int updateContentStatus(String name,
                        Locale locale,
                        Status oldStatus,
                        Status newStatus)
                 throws Exception

This will cause an update to the Content state. Note, it is the responsibility of the calling API to ensure that the content status is not conflicting with an existing state.

For example: If a content (for the locale) is in status Status.DRAFT, and is being updated to Status.PUBLISH while another Status.PUBLISH one already exists. Then it should update the PUBLISH record for the content and mute the Status.DRAFT one (in concept).

Parameters:

name - as identifier for the content

locale - as the Locale

oldStatus - as the Status

newStatus - as the Status (replace the oldStatus with this value)

Returns:

int as number of rows updated

Throws:

Exception

saveFacet

CF saveFacet(CF cf)

Save a Facet

Parameters:

cf - as ContentFacet

Returns:

publish

C publish(C content)
   throws Exception

Clone Preview C record (& related ContentFacets, attributes) to publish

Parameters:

content - (this should be a record with C#getStatus() as Status.DRAFT)

Returns:

C (the publish version)

Throws:

Exception

unPublish

void unPublish(C content)
        throws Exception

Delete published version from source.

Parameters:

content -

Throws:

Exception

publish

void publish(Collection<C> contents)
      throws Exception

Clone Preview C record(s) (& related ContentFacets, attributes) to publish

Parameters:

content - (these should be records with C#getStatus() as Status.DRAFT)

Throws:

Exception

updateContentMetaAll

void updateContentMetaAll(C content,
                          String[] selectedAttribs)

Will update the aspects of C displayName, attributes & Bit mask across all copies of the Content(for each Status), but not across languages

Parameters:

content - (Only Those attributes are updated that are in the content object; Supports partial Attribute update)

String[] - if specified, only specified attributes will be updated @nullable true

updateContentName

void updateContentName(String oldName,
                       String newName)

Update C#setName(String)

Parameters:

content - as C

query

@Transactional(readOnly=true)
List<C> query(Query<C> query)
                                     throws Exception

Execute Query and on Queryable fields only.
If a field is to be search on NULL, then explicitly add the Java field name to the nullSet
Also note that beans that do not follow standard java bean naming conventions; on their Queryable fields will face problems.

Parameters:

queryEntity - as Queryable

Throws:

Exception

queryPage

@Transactional(readOnly=true)
Page<C> queryPage(Query<C> query)
                                         throws Exception

Execute Query and on Queryable fields only.
If a field is to be search on NULL, then explicitly add the Java field name to the Query.setNullSet(Set)
Also note that beans that do not follow standard java bean naming conventions; on their Queryable fields will face problems.

Parameters:

query - as Queryable

Throws:

Exception