pulse - the web application framework Get pulse at SourceForge.net. Fast, secure and Free Open Source software downloads Ohloh project report for pulse-java

org.torweg.pulse.site.content
Class AbstractBasicContent

java.lang.Object
  extended by org.torweg.pulse.util.entity.AbstractBasicEntity
      extended by org.torweg.pulse.util.entity.AbstractNamedEntity
          extended by org.torweg.pulse.util.entity.AbstractNamableEntity
              extended by org.torweg.pulse.site.content.Content
                  extended by org.torweg.pulse.site.content.AbstractBasicContent
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Content>, ExtendedJDOMable, JDOMable, ILinkCorretable, INameable, INamed
Direct Known Subclasses:
AbstractSummaryDescriptionContent, CMSContent, FileContent, FilterContent, URLContent

@MappedSuperclass
public abstract class AbstractBasicContent
extends Content
implements ExtendedJDOMable

Version:
$Revision: 1984 $
Author:
Christian Schatt, Daniel Dietz
See Also:
Serialized Form

Field Summary
static java.lang.String DEFAULT_SUFFIX
          The default suffix of the AbstractBasicContent.
 
Constructor Summary
AbstractBasicContent()
           
 
Method Summary
abstract  AbstractBasicContent createCopy(java.util.Locale l, User u)
          overrides Content.createCopy(Locale, User).
 org.jdom.Element deserializeToJDOM()
          Returns the state of the AbstractBasicContent as a JDOM Element.
 org.jdom.Element deserializeToJDOM(ServiceRequest pServiceRequest)
          Returns the state of the AbstractBasicContent as a JDOM Element.
 java.lang.StringBuilder getFullTextValue()
          Returns the AbstractBasicContent's textual information as it is supposed to be supplied for the index.
 java.lang.String getKeywords()
          Returns the keywords of the AbstractBasicContent.
 java.util.Set<ILinkCorrectableElement> getLinkCorrectables()
          a set with the Elements to be corrected.
 java.lang.String getMetaDescription()
          returns the description to be used for mark-up languages with a support for document descriptions, e.g.
 java.lang.String getMetaKeywords()
          returns the keywords to be used for mark-up languages with a support for document keywords, e.g.
 java.lang.String getSuffix()
          Returns the suffix of the AbstractBasicContent.
 java.lang.String getSummary()
          Returns the summary of the AbstractBasicContent.
 org.jdom.Element getSummaryElement()
          Returns the summary of the AbstractBasicContent as a JDOM Element.
 java.lang.String getTitle()
          returns the title to be used for mark-up languages with a support for document titles, e.g.
 void setKeywords(java.lang.String pKeywords)
          Sets the keywords of the AbstractBasicContent.
 void setMetaDescription(java.lang.String md)
          sets the keywords to be used for mark-up languages with a support for document descriptions, e.g.
 void setMetaKeywords(java.lang.String kw)
          sets the keywords to be used for mark-up languages with a support for document keywords, e.g.
 void setSuffix(java.lang.String pSuffix)
          Sets the suffix of the AbstractBasicContent.
 void setSummary(org.jdom.Element pSummaryElement)
          Sets the summary of the AbstractBasicContent from a JDOM Element.
 void setTitle(java.lang.String t)
          sets the title to be used for mark-up languages with a support for document titles, e.g.
 
Methods inherited from class org.torweg.pulse.site.content.Content
compareTo, equals, getAssociatedViews, getAssociatedVirtualFiles, getAttachments, getBundle, getCreated, getCreatedMillis, getCreator, getLastModified, getLastModifier, getLocale, getLocalizationMap, getLocalizationMapJAXB, getReferenceDuration, getViewTypes, hashCode, hasReferenceDuration, initLazyFields, initLazyImageGroups, initLazyVariants, isGroup, onVirtualFileSystemChange, processHTML, removeReferenceDuration, setAssociatedVirtualFiles, setAttachments, setBundle, setCreator, setLastModifier, setLocale, setLocalizationMap, setReferenceDuration, toString, updateAssociatedVirtualFiles, updateHTML, updateLocalizationMap
 
Methods inherited from class org.torweg.pulse.util.entity.AbstractNamableEntity
setName
 
Methods inherited from class org.torweg.pulse.util.entity.AbstractNamedEntity
getName
 
Methods inherited from class org.torweg.pulse.util.entity.AbstractBasicEntity
compareTo, getFullQualifiedClassNameJAXB, getId
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.torweg.pulse.util.INameable
setName
 
Methods inherited from interface org.torweg.pulse.util.INamed
getName
 

Field Detail

DEFAULT_SUFFIX

public static final java.lang.String DEFAULT_SUFFIX
The default suffix of the AbstractBasicContent.

See Also:
Constant Field Values
Constructor Detail

AbstractBasicContent

public AbstractBasicContent()
Method Detail

getSummary

public final java.lang.String getSummary()
Returns the summary of the AbstractBasicContent.

Returns:
the summary of the AbstractBasicContent.

setSummary

public final void setSummary(org.jdom.Element pSummaryElement)
Sets the summary of the AbstractBasicContent from a JDOM Element.

Parameters:
pSummaryElement - the JDOM Element representing the summary to be set.

getSummaryElement

public final org.jdom.Element getSummaryElement()
Returns the summary of the AbstractBasicContent as a JDOM Element.

Returns:
the summary of the AbstractBasicContent as a JDOM Element.

getTitle

public final java.lang.String getTitle()
returns the title to be used for mark-up languages with a support for document titles, e.g. HTML.

Returns:
the title

setTitle

public final void setTitle(java.lang.String t)
sets the title to be used for mark-up languages with a support for document titles, e.g. HTML.

Parameters:
t - the title to set

getMetaKeywords

public final java.lang.String getMetaKeywords()
returns the keywords to be used for mark-up languages with a support for document keywords, e.g. HTML through meta-keywords.

Returns:
the meta keywords

setMetaKeywords

public final void setMetaKeywords(java.lang.String kw)
sets the keywords to be used for mark-up languages with a support for document keywords, e.g. HTML through meta-keywords.

Parameters:
kw - the meta keywords to set

getMetaDescription

public final java.lang.String getMetaDescription()
returns the description to be used for mark-up languages with a support for document descriptions, e.g. HTML through meta-descriptions.

Returns:
the meta description

setMetaDescription

public final void setMetaDescription(java.lang.String md)
sets the keywords to be used for mark-up languages with a support for document descriptions, e.g. HTML through meta-descriptions.

Parameters:
md - the meta description to set

getSuffix

public final java.lang.String getSuffix()
Returns the suffix of the AbstractBasicContent.

Returns:
the suffix of the AbstractBasicContent.

setSuffix

public final void setSuffix(java.lang.String pSuffix)
Sets the suffix of the AbstractBasicContent.

If the given String contains at least one /, the part after its last occurrence will be set as suffix. If the given String is null, the suffix will be set to DEFAULTSUFFIX.

Parameters:
pSuffix - the suffix to be set.

getKeywords

public final java.lang.String getKeywords()
Returns the keywords of the AbstractBasicContent.

Returns:
the keywords of the AbstractBasicContent.

setKeywords

public final void setKeywords(java.lang.String pKeywords)
Sets the keywords of the AbstractBasicContent.

If the given String is longer than 255 characters, it will be shortened to a maximum length of 255 characters, ending at the last space character within this range.

Parameters:
pKeywords - the keywords to be set.

getFullTextValue

public java.lang.StringBuilder getFullTextValue()
Returns the AbstractBasicContent's textual information as it is supposed to be supplied for the index.

Implementing classes may override the method to supply more information for the index.

Specified by:
getFullTextValue in class Content
Returns:
the AbstractBasicContent's textual information as it is supposed to be supplied for the index.

deserializeToJDOM

public org.jdom.Element deserializeToJDOM()
Returns the state of the AbstractBasicContent as a JDOM Element.

Specified by:
deserializeToJDOM in interface JDOMable
Returns:
the state of the AbstractBasicContent as a JDOM Element.

deserializeToJDOM

public org.jdom.Element deserializeToJDOM(ServiceRequest pServiceRequest)
Returns the state of the AbstractBasicContent as a JDOM Element.

Specified by:
deserializeToJDOM in interface ExtendedJDOMable
Parameters:
pServiceRequest - the current ServiceRequest or null.
Returns:
the state of the AbstractBasicContent as a JDOM Element.

createCopy

public abstract AbstractBasicContent createCopy(java.util.Locale l, User u)
overrides Content.createCopy(Locale, User).

Specified by:
createCopy in class Content
Parameters:
l - the locale for the copy
u - the user for the copy
Returns:
the copy of the AbstractBasicContent

getLinkCorrectables

public java.util.Set<ILinkCorrectableElement> getLinkCorrectables()
Description copied from interface: ILinkCorretable
a set with the Elements to be corrected.

Specified by:
getLinkCorrectables in interface ILinkCorretable
Returns:
the set of ILinkCorrectableElements
See Also:
ILinkCorretable.getLinkCorrectables()