public class PresentationArticleImpl extends AbstractPresentationArticle
PresentationArticleImpl
provides a high performance, read-only
class to access Escenic content items - the basic components of an Escenic publication.
Modifier and Type | Class and Description |
---|---|
class |
PresentationArticleImpl.PresentationArticleURITranslator
Deprecated.
|
Modifier and Type | Field and Description |
---|---|
protected static org.apache.log4j.Logger |
LOGGER
Deprecated.
|
static int |
mHomeSectionValidationTimeout
Deprecated.
|
COM_ESCENIC_PRESENTATION_INTERNAL
Constructor and Description |
---|
PresentationArticleImpl(Article pApiArticle,
PresentationLoader pPresentationLoader,
ArticlePresentationManager pArticlePresentationManager)
Deprecated.
Construct an instance of the PresentationArticle on basis of a
neo.xredsys.api.Article.
|
PresentationArticleImpl(PresentationArticleImpl pa,
IOHashKey pSectionKey)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
protected Map<String,PresentationElement> |
findContentSummaries(Article pApiArticle,
int pPubId)
Deprecated.
|
protected List<PresentationRelation> |
findRelatedArticles(int pubId)
Deprecated.
|
String |
getActivatedDate(String formated,
Locale locale)
Deprecated.
Returns a formatted String of the activation date.
|
Date |
getActivatedDateAsDate()
Deprecated.
Returns the date this content item was activated.
|
AgreementInfo |
getAgreementInfo()
Deprecated.
Returns this content item's agreement information or
null if the content item has no agreement. |
List<PresentationRelation> |
getAllRelatedObjects()
Deprecated.
|
int |
getAllRelatedObjectsCount()
Deprecated.
|
protected Article |
getAPIArticle()
Deprecated.
|
int |
getArticleId()
Deprecated.
Returns the database id of this content item.
|
List |
getArticles()
Deprecated.
Returns all the content items related to this content item.
|
List |
getArticles(Set pArticleTypes)
Deprecated.
Returns all the content items of the specified types that is related to this content item.
|
int |
getArticlesCount()
Deprecated.
Returns the number of content items related to this content item.
|
String |
getArticleTypeName()
Deprecated.
Returns the type of this content item (as defined in the
content-type resource). |
Person |
getAuthor()
Deprecated.
Returns the author of this content item.
|
List |
getAuthors()
Deprecated.
Returns all the authors of this content item.
|
int |
getAuthorsCount()
Deprecated.
Returns the number of authors responsible for this content item.
|
IORelationContentSummaryConverter |
getContentSummaryConverter()
Deprecated.
|
String |
getCreatedDate(String formated,
Locale locale)
Deprecated.
Returns a formatted String of the creation date.
|
Date |
getCreatedDateAsDate()
Deprecated.
Returns the date this content item was created.
|
String |
getExpireDate(String formated,
Locale locale)
Deprecated.
Returns a formatted date of when this content item is due to expire.
|
Date |
getExpireDateAsDate()
Deprecated.
Returns the date on which this content item expired/will expire.
|
String |
getFieldElement(String pKey)
Deprecated.
Gets the string value of the specified content item fields.
|
String |
getFieldElementDefaultValue(String pKey)
Deprecated.
Default value of the content item text field.
|
List<String> |
getFieldNames()
Deprecated.
Returns the names of all this content item's fields.
|
Map<String,PresentationProperty<?>> |
getFields()
Deprecated.
Returns all the fields in this content item.
|
String |
getFirstPublishedDate(String formated,
Locale locale)
Deprecated.
Returns a formatted date of when this content item was first published
The date will be formatted using the supplied format and locale.
|
Date |
getFirstPublishedDateAsDate()
Deprecated.
Returns the date on which this content item was first published.
|
IOHashKey |
getHashKey()
Deprecated.
Returns the hash key of this object.
|
Section |
getHomeSection()
Deprecated.
Returns the home section of this content item.
|
int |
getId()
Deprecated.
Gets the id of this article
|
Map<String,PresentationElement> |
getInlineElements()
Deprecated.
Returns a
Map of all inline elements for this content item. |
String |
getLastModifiedDate(String formated,
Locale locale)
Deprecated.
Returns a formatted date of when this content item was last modified.
|
Date |
getLastModifiedDateAsDate()
Deprecated.
Returns the date on which this content item was last modified.
|
int |
getLayoutId()
Deprecated.
|
Section |
getOwnerHomeSection()
Deprecated.
Returns the owner home section of this content item.
|
String |
getOwnerUrl()
Deprecated.
Returns the absolute URL of this content item in its owning home section.
|
Collection |
getPersons()
Deprecated.
Returns all the persons related to this content item.
|
int |
getPersonsCount()
Deprecated.
Returns the number of persons related to this content item.
|
String |
getPreviewToken()
Deprecated.
Returns the preview token
|
boolean |
getPrinted()
Deprecated.
|
int |
getPriority()
Deprecated.
The priority of this content item.
|
List<PresentationPerson> |
getProfilePersons()
Deprecated.
Returns a list of all the persons related to this content item where the relation type is profile.
|
Publication |
getPublication()
Deprecated.
Returns the publication this content item belongs to.
|
int |
getPublicationId()
Deprecated.
Returns the database id of the publication this content item belongs to.
|
String |
getPublishedDate(String formated,
Locale locale)
Deprecated.
Returns a formatted date of when this content item was last published
The date will be formatted using the supplied format and locale.
|
Date |
getPublishedDateAsDate()
Deprecated.
Returns the date on which this content item was last published.
|
Map<String,PresentationElement> |
getRelatedElements()
Deprecated.
Returns a Map from relation type to a
PresentationElement that holds the relations to this object. |
Set<PresentationElement> |
getRelatedElements(Set<String> pContentTypes)
Deprecated.
Returns a Set of related PresentationElements of the given content types.
|
URI |
getRelativeURI()
Deprecated.
Returns the URL of this content item relative to its section.
|
String |
getRelativeUrl()
Deprecated.
Returns the URL of this content item relative to its section.
|
Section[] |
getSections()
Deprecated.
Returns the sections this content item belongs to.
|
List |
getSectionsList()
Deprecated.
Returns the sections this content item belongs to.
|
String |
getSource()
Deprecated.
Returns the name of the external source of an imported content item.
|
String |
getSourceId()
Deprecated.
Returns the id of the external source of an imported content item.
|
String |
getStateChangedDate(String formated,
Locale locale)
Deprecated.
Returns a formatted date of when this content item's state was updated
The date will be formatted using the supplied format and locale.
|
Date |
getStateChangedDateAsDate()
Deprecated.
Returns the date on which the state of this content item last changed.
|
String |
getStateName()
Deprecated.
Returns the state of this content item.
|
List<PresentationTag> |
getTags()
Deprecated.
Returns a List of presentation tags.
|
String |
getTitle()
Deprecated.
Returns the title of this content item.
|
String |
getUrl()
Deprecated.
Returns the absolute URL of this content item.
|
boolean |
inSection(int pSectionId)
Deprecated.
Check to see if the content item is in the given section.
|
boolean |
inSection(Section pSection)
Deprecated.
Check to see if the content item is in the given section.
|
boolean |
isAgreementRequired()
Deprecated.
Returns
true if an agreement is required to view this content item,
otherwise false . |
boolean |
isLive()
Deprecated.
Returns
true if this content item is published and active and its home section is published,
otherwise false . |
boolean |
isOwner()
Deprecated.
Returns
true if this content item is in its owning publication, false if
it is a cross-published content item that is being accessed from a foreign publication. |
boolean |
isPreview()
Deprecated.
Checks whether the presentation article is a preview or not
returns true if the presentation article is a preview
|
getActivatedDate, getActivatedDate, getActivatedDate, getArticlesCount, getCreatedDate, getCreatedDate, getCreatedDate, getExpireDate, getExpireDate, getExpireDate, getFirstPublishedDate, getFirstPublishedDate, getFirstPublishedDate, getLastModifiedDate, getLastModifiedDate, getLastModifiedDate, getPublishedDate, getPublishedDate, getPublishedDate, getStateChangedDate, getStateChangedDate, getStateChangedDate
protected static transient org.apache.log4j.Logger LOGGER
public static int mHomeSectionValidationTimeout
public PresentationArticleImpl(Article pApiArticle, PresentationLoader pPresentationLoader, ArticlePresentationManager pArticlePresentationManager)
pApiArticle
- the neo.xredsys.api.Article to be used to create a
PresentationArticlepPresentationLoader
- pArticlePresentationManager
- the manager creating this instancepublic PresentationArticleImpl(PresentationArticleImpl pa, IOHashKey pSectionKey)
public String getPreviewToken()
PresentationArticle
getPreviewToken
in interface PresentationArticle
getPreviewToken
in class AbstractPresentationArticle
public boolean isPreview()
PresentationArticle
isPreview
in interface PresentationArticle
isPreview
in class AbstractPresentationArticle
true
if the current content item is preview, false
if not.protected Map<String,PresentationElement> findContentSummaries(Article pApiArticle, int pPubId)
protected List<PresentationRelation> findRelatedArticles(int pubId)
public IORelationContentSummaryConverter getContentSummaryConverter()
public Date getActivatedDateAsDate()
PresentationArticle
public String getActivatedDate(String formated, Locale locale)
PresentationArticle
PresentationArticle.getActivatedDate()
instead.formated
- how the date will be formatted. The given string defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.locale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.public Date getCreatedDateAsDate()
PresentationArticle
public String getCreatedDate(String formated, Locale locale)
PresentationArticle
PresentationArticle.getCreatedDate()
instead.formated
- how the date will be formatted. The given string defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.locale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.public Date getExpireDateAsDate()
PresentationArticle
public String getExpireDate(String formated, Locale locale)
PresentationArticle
PresentationArticle.getCreatedDate()
instead.formated
- how the date will be formatted. The given string defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.locale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.public Date getFirstPublishedDateAsDate()
PresentationArticle
public String getFirstPublishedDate(String formated, Locale locale)
PresentationArticle
PresentationArticle.getFirstPublishedDate()
instead.formated
- how the date will be formatted. The given string defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.locale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.public Date getLastModifiedDateAsDate()
PresentationArticle
public String getLastModifiedDate(String formated, Locale locale)
PresentationArticle
PresentationArticle.getLastModifiedDate()
instead.formated
- how the date will be formatted. The given string defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.locale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.public Date getPublishedDateAsDate()
PresentationArticle
PresentationArticle.getPublishedDate()
public String getPublishedDate(String formated, Locale locale)
PresentationArticle
PresentationArticle.getPublishedDate()
instead.formated
- how the date will be formatted. The given string defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.locale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.public Date getStateChangedDateAsDate()
PresentationArticle
public String getStateChangedDate(String formated, Locale locale)
PresentationArticle
PresentationArticle.getStateChangedDate()
instead.formated
- how the date will be formatted. The given string defined by SimpleDateFormat
E.G: "yyyy-MM-dd'T'HH:mm:ss.SSSZ".
If you do not supply a value (null
), the date is formatted specified by DateFormat.SHORT
.locale
- in which locale the date will be resolved.
If you do not supply a value (null
), the date is resolved with the server's default locale.public int getArticleId()
PresentationArticle
getArticleId
in interface PresentationArticle
getArticleId
in class AbstractPresentationArticle
public String getArticleTypeName()
PresentationArticle
content-type
resource).public Person getAuthor()
PresentationArticle
getAuthor
in interface PresentationArticle
getAuthor
in class AbstractPresentationArticle
public List getAuthors()
PresentationArticle
List
of neo.xredsys.api.Person
.public int getAuthorsCount()
PresentationArticle
getAuthorsCount
in interface PresentationArticle
getAuthorsCount
in class AbstractPresentationArticle
public Section getHomeSection()
PresentationArticle
Section
sectionpublic Section getOwnerHomeSection()
PresentationArticle
public int getId()
public int getLayoutId()
public boolean getPrinted()
public int getPriority()
PresentationArticle
public Publication getPublication()
PresentationArticle
public int getPublicationId()
PresentationArticle
public String getRelativeUrl()
PresentationArticle
article123.ece
.public URI getRelativeURI()
PresentationArticle
article123.ece
.public Section[] getSections()
PresentationArticle
getSections
in interface PresentationArticle
getSections
in class AbstractPresentationArticle
Section
this content item belongs to.public List getSectionsList()
PresentationArticle
public String getSource()
PresentationArticle
source
together with
PresentationArticle.getSourceId()
uniquely identifies the original source of the content item.public String getSourceId()
PresentationArticle
sourceId
together with
PresentationArticle.getSource()
uniquely identifies the original source of the content item.public String getTitle()
PresentationArticle
public String getUrl()
PresentationArticle
public String getOwnerUrl()
PresentationArticle
PresentationArticle.getUrl()
, which returns the content item's URL in its current section.
For a cross-published content item both the section and publication components of the URL will
differ.public boolean isAgreementRequired()
PresentationArticle
true
if an agreement is required to view this content item,
otherwise false
.true
if this content item need an agreement, false
if not.public boolean isLive()
PresentationArticle
true
if this content item is published and active and its home section is published,
otherwise false
.public AgreementInfo getAgreementInfo()
PresentationArticle
null
if the content item has no agreement.public boolean inSection(int pSectionId)
PresentationArticle
pSectionId
- The sectionId to the section we will check.true
if the content item is in the section, false
otherwise.public boolean inSection(Section pSection)
PresentationArticle
pSection
- The section to check.true
if the content item is in the section, false
otherwise.public String getFieldElement(String pKey)
PresentationArticle
pKey
- The text field to get.public List<String> getFieldNames()
PresentationArticle
content-types.xml
, and
in upper case letters.public Map<String,PresentationProperty<?>> getFields()
PresentationArticle
Object
s representing the fields depends upon field type as follows:
Field type | Java Object |
---|---|
BASIC | String |
NUMBER | a subclass of Number |
COMPLEX | Map |
BOOLEAN | Boolean |
ENUMERATION | a String or List of Strings |
URI | URI |
LINK | Link |
DATE | Date |
SCHEDULE | PresentationSchedule |
public String getFieldElementDefaultValue(String pKey)
PresentationArticle
pKey
- The text field to get default value from.public Collection getPersons()
PresentationArticle
persons
related to this content itempublic int getPersonsCount()
PresentationArticle
getPersonsCount
in interface PresentationArticle
getPersonsCount
in class AbstractPresentationArticle
public Map<String,PresentationElement> getRelatedElements()
PresentationArticle
PresentationElement
that holds the relations to this object.PresentationElement
that holds the relations to this object.public Set<PresentationElement> getRelatedElements(Set<String> pContentTypes)
PresentationArticle
pContentTypes
- the content types to search forpublic List getArticles()
PresentationArticle
neo.xredsys.presentation.PresentationRelationArticle
public List getArticles(Set pArticleTypes)
PresentationArticle
pArticleTypes
- this is a Set
of the named content item types.neo.xredsys.presentation.PresentationRelationArticle
public int getArticlesCount()
PresentationArticle
getArticlesCount
in interface PresentationArticle
getArticlesCount
in class AbstractPresentationArticle
public List<PresentationRelation> getAllRelatedObjects()
public int getAllRelatedObjectsCount()
public Map<String,PresentationElement> getInlineElements()
PresentationArticle
Map
of all inline elements for this content item. The key of this map represents the ID of the inline
element.Map
of all inline elements for this content item.public String getStateName()
PresentationArticle
public IOHashKey getHashKey()
PresentationObject
public List<PresentationTag> getTags()
PresentationArticle
public boolean isOwner()
PresentationArticle
true
if this content item is in its owning publication, false
if
it is a cross-published content item that is being accessed from a foreign publication.true
if the current content item is the owner, false
if not.protected Article getAPIArticle()
public List<PresentationPerson> getProfilePersons()
PresentationArticle
© 1998- 2021 Escenic AS