StandardDisplayableModel (stallion-core 1.0.0-SNAPSHOT API)

java.lang.Object
- io.stallion.dataAccess.ModelBase
- - io.stallion.dataAccess.StandardDisplayableModel

All Implemented Interfaces:

Displayable, Model

Direct Known Subclasses:

TextItem
```
public class StandardDisplayableModel
extends ModelBase
implements Displayable
```
A base class for model objects that can be rendered as web pages.

Field Summary
- Fields inherited from class io.stallion.dataAccess.ModelBase
  meta

Constructor Summary

Constructors
Constructor and Description

StandardDisplayableModel()

Constructors
Constructor and Description
`StandardDisplayableModel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`formatPublishDate()`
`String`	`formatPublishDate(String pattern)`
`String`	`formattedDate(String format)` Get the publish date and format it with the passed in DateTimeFormatter
`String`	`getAuthor()` Get the author name of this page.
`String`	`getContent()` The actual page content that gets displayed in the body of the web page.
`String`	`getContentType()`
`ZonedDateTime`	`getDate()`
`Boolean`	`getDraft()` If true, the page will not be visible.
`String`	`getImage()` Get used for the og:image meta tag.
`String`	`getMetaDescription()` For the description meta tag, often used by Google and others to give a one sentence explanation of the page in search results.
`String`	`getMetaKeywords()` Get a list of comma separated keywords for the keywords tag.
`String`	`getOgType()` OpenGraph page type, for the HTML meta section
`List<String>`	`getOldUrls()` If you change the URL of a page, add the old url here, Stallion will then 301 redirect the old url to the new url.
`String`	`getOriginalContent()`
`String`	`getOverrideDomain()` Empty by default, but if secondary domains are found, and the page slug matches that of a secondary domain, then this method will return the secondary domain.
`String`	`getPermalink()` Get the full URL to this page
`String`	`getPreviewKey()` Set this to some custom value, and then you can view an unpublished page via /slug?stPreview=(your preview key)
`ZonedDateTime`	`getPublishDate()` Get the date at which the page should be live, if this is in the future, the page will not be visible.
`Boolean`	`getPublished()` True if draft is false, and publishDate is before the current time.
`String`	`getRealHttpPath()` The path component of the URL at which this page can be accessed.
`String`	`getRelCanonical()` Used for the canonical tag in the HTML head section, set this manually if this page is accessible at multiple URL's and you do not want to get duplicate content penalties in Google.
`String`	`getSlug()` The user settable path component of the URL at which this page can be accessed, before applying the override/secondary domain (if applicable)
`String`	`getSlugForCssId()` Creates a CSS id for the page <body> tag based on the slug.
`String`	`getSummary()`
`String`	`getTemplate()` The path of the template used to render the page.
`String`	`getTitle()` Used in the page <title> tag.
`String`	`getTitleTag()`
`String`	`getTruncatedSummary(int max)`
`<D extends StandardDisplayableModel> D`	`setAuthor(String author)`
`<D extends StandardDisplayableModel> D`	`setContent(String content)`
`StandardDisplayableModel`	`setContentType(String contentType)`
`<D extends StandardDisplayableModel> D`	`setDraft(Boolean draft)`
`<D extends StandardDisplayableModel> D`	`setImage(String image)`
`<D extends StandardDisplayableModel> D`	`setMetaDescription(String metaDescription)`
`<D extends StandardDisplayableModel> D`	`setMetaKeywords(String metaKeywords)`
`<D extends StandardDisplayableModel> D`	`setOgType(String ogType)`
`<D extends Displayable> D`	`setOldUrls(List<String> oldUrls)`
`<D extends StandardDisplayableModel> D`	`setOriginalContent(String originalContent)`
`<D extends StandardDisplayableModel> D`	`setPreviewKey(String previewKey)`
`<D extends StandardDisplayableModel> D`	`setPublishDate(ZonedDateTime publishDate)`
`<D extends StandardDisplayableModel> D`	`setRelCanonical(String relCanonical)`
`<D extends StandardDisplayableModel> D`	`setSlug(String slug)`
`<D extends StandardDisplayableModel> D`	`setTemplate(String template)`
`StandardDisplayableModel`	`setTitle(String title)`
`<D extends StandardDisplayableModel> D`	`setTitleTag(String titleTag)`

Methods inherited from class io.stallion.dataAccess.ModelBase
equals, getBucket, getCompoundId, getController, getDeleted, getId, getIsNewInsert, getLastModifiedMillis, getMeta, hashCode, setBucket, setDeleted, setId, setIsNewInsert, setLastModifiedMillis

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.stallion.dataAccess.Model
getBucket, getCompoundId, getController, getDeleted, getId, getIsNewInsert, getLastModifiedMillis, setBucket, setDeleted, setId, setIsNewInsert, setLastModifiedMillis

- Constructor Detail
  - StandardDisplayableModel
```
public StandardDisplayableModel()
```
- Method Detail
  - getTitle
```
public String getTitle()
```
    Used in the page <title> tag.
    
    Specified by:
    
    getTitle in interface Displayable
    
    Returns:
  - setTitle
```
public StandardDisplayableModel setTitle(String title)
```
  - getSlug
```
public String getSlug()
```
    The user settable path component of the URL at which this page can be accessed, before applying the override/secondary domain (if applicable)
    
    Specified by:
    
    getSlug in interface Displayable
    
    Returns:
  - getRealHttpPath
```
public String getRealHttpPath()
```
    The path component of the URL at which this page can be accessed. This is the slug by default, but if on an override domain, the slug minus the root
    
    Specified by:
    
    getRealHttpPath in interface Displayable
  - getOverrideDomain
```
public String getOverrideDomain()
```
    Empty by default, but if secondary domains are found, and the page slug matches that of a secondary domain, then this method will return the secondary domain.
    
    Specified by:
    
    getOverrideDomain in interface Displayable
    
    Returns:
  - getSlugForCssId
```
public String getSlugForCssId()
```
    Creates a CSS id for the page <body> tag based on the slug. This is used to make it easy to do per-page stylings in a stylesheet.
    
    Specified by:
    
    getSlugForCssId in interface Displayable
    
    Returns:
  - getContent
```
public String getContent()
```
    The actual page content that gets displayed in the body of the web page. This should already be HTML (for HTML pages).
    
    Specified by:
    
    getContent in interface Displayable
    
    Returns:
  - setSlug
```
public <D extends StandardDisplayableModel> D setSlug(String slug)
```
  - setContent
```
public <D extends StandardDisplayableModel> D setContent(String content)
```
  - getTemplate
```
public String getTemplate()
```
    The path of the template used to render the page. Will default to page.jinja if it is not set.
    
    Specified by:
    
    getTemplate in interface Displayable
    
    Returns:
  - setTemplate
```
public <D extends StandardDisplayableModel> D setTemplate(String template)
```
  - getPublishDate
```
public ZonedDateTime getPublishDate()
```
    Get the date at which the page should be live, if this is in the future, the page will not be visible.
    
    Specified by:
    
    getPublishDate in interface Displayable
    
    Returns:
  - setPublishDate
```
public <D extends StandardDisplayableModel> D setPublishDate(ZonedDateTime publishDate)
```
  - getDraft
```
public Boolean getDraft()
```
    If true, the page will not be visible.
    
    Specified by:
    
    getDraft in interface Displayable
    
    Returns:
  - setDraft
```
public <D extends StandardDisplayableModel> D setDraft(Boolean draft)
```
  - getPublished
```
public Boolean getPublished()
```
    True if draft is false, and publishDate is before the current time.
    
    Specified by:
    
    getPublished in interface Displayable
    
    Returns:
  - getDate
```
public ZonedDateTime getDate()
```
  - formattedDate
```
public String formattedDate(String format)
```
    Get the publish date and format it with the passed in DateTimeFormatter
    
    Parameters:
    
    format -
    
    Returns:
  - getPermalink
```
public String getPermalink()
```
    Get the full URL to this page
    
    Specified by:
    
    getPermalink in interface Displayable
    
    Returns:
  - getAuthor
```
public String getAuthor()
```
    Get the author name of this page.
    
    Returns:
  - setAuthor
```
public <D extends StandardDisplayableModel> D setAuthor(String author)
```
  - getMetaDescription
```
public String getMetaDescription()
```
    For the description meta tag, often used by Google and others to give a one sentence explanation of the page in search results.
    
    Specified by:
    
    getMetaDescription in interface Displayable
    
    Returns:
  - setMetaDescription
```
public <D extends StandardDisplayableModel> D setMetaDescription(String metaDescription)
```
  - getRelCanonical
```
public String getRelCanonical()
```
    Used for the canonical tag in the HTML head section, set this manually if this page is accessible at multiple URL's and you do not want to get duplicate content penalties in Google.
    
    Specified by:
    
    getRelCanonical in interface Displayable
    
    Returns:
  - setRelCanonical
```
public <D extends StandardDisplayableModel> D setRelCanonical(String relCanonical)
```
  - getMetaKeywords
```
public String getMetaKeywords()
```
    Get a list of comma separated keywords for the keywords tag.
    
    Specified by:
    
    getMetaKeywords in interface Displayable
    
    Returns:
  - setMetaKeywords
```
public <D extends StandardDisplayableModel> D setMetaKeywords(String metaKeywords)
```
  - getTitleTag
```
public String getTitleTag()
```
    Specified by:
    
    getTitleTag in interface Displayable
  - setTitleTag
```
public <D extends StandardDisplayableModel> D setTitleTag(String titleTag)
```
  - getImage
```
public String getImage()
```
    Get used for the og:image meta tag.
    
    Specified by:
    
    getImage in interface Displayable
    
    Returns:
  - setImage
```
public <D extends StandardDisplayableModel> D setImage(String image)
```
  - getOgType
```
public String getOgType()
```
    OpenGraph page type, for the HTML meta section
    
    Specified by:
    
    getOgType in interface Displayable
    
    Returns:
  - setOgType
```
public <D extends StandardDisplayableModel> D setOgType(String ogType)
```
  - getPreviewKey
```
public String getPreviewKey()
```
    Set this to some custom value, and then you can view an unpublished page via /slug?stPreview=(your preview key)
    
    Specified by:
    
    getPreviewKey in interface Displayable
    
    Returns:
  - setPreviewKey
```
public <D extends StandardDisplayableModel> D setPreviewKey(String previewKey)
```
  - getOldUrls
```
public List<String> getOldUrls()
```
    If you change the URL of a page, add the old url here, Stallion will then 301 redirect the old url to the new url.
    
    Specified by:
    
    getOldUrls in interface Displayable
    
    Returns:
  - setOldUrls
```
public <D extends Displayable> D setOldUrls(List<String> oldUrls)
```
    Specified by:
    
    setOldUrls in interface Displayable
  - getOriginalContent
```
public String getOriginalContent()
```
    Specified by:
    
    getOriginalContent in interface Displayable
  - setOriginalContent
```
public <D extends StandardDisplayableModel> D setOriginalContent(String originalContent)
```
  - getSummary
```
public String getSummary()
```
  - getTruncatedSummary
```
public String getTruncatedSummary(int max)
```
  - formatPublishDate
```
public String formatPublishDate()
```
  - formatPublishDate
```
public String formatPublishDate(String pattern)
```
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface Displayable
  - setContentType
```
public StandardDisplayableModel setContentType(String contentType)
```

Class StandardDisplayableModel

Field Summary

Fields inherited from class io.stallion.dataAccess.ModelBase

Constructor Summary

Method Summary

Methods inherited from class io.stallion.dataAccess.ModelBase

Methods inherited from class java.lang.Object

Methods inherited from interface io.stallion.dataAccess.Model

Constructor Detail

StandardDisplayableModel

Method Detail

getTitle

setTitle

getSlug

getRealHttpPath

getOverrideDomain

getSlugForCssId

getContent

setSlug

setContent

getTemplate

setTemplate

getPublishDate

setPublishDate

getDraft

setDraft

getPublished

getDate

formattedDate

getPermalink

getAuthor

setAuthor

getMetaDescription

setMetaDescription

getRelCanonical

setRelCanonical

getMetaKeywords

setMetaKeywords

getTitleTag

setTitleTag

getImage

setImage

getOgType

setOgType

getPreviewKey

setPreviewKey

getOldUrls

setOldUrls

getOriginalContent

setOriginalContent

getSummary

getTruncatedSummary

formatPublishDate

formatPublishDate

getContentType

setContentType