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.filter
Class FilterContent

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
                      extended by org.torweg.pulse.site.content.filter.FilterContent
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Content>, ExtendedJDOMable, JDOMable, ILinkCorretable, INameable, INamed

@Entity
public class FilterContent
extends AbstractBasicContent

Version:
$Revision: 1401 $
Author:
Thomas Weber, Daniel Dietz
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.torweg.pulse.site.content.AbstractBasicContent
DEFAULT_SUFFIX
 
Constructor Summary
protected FilterContent()
          Deprecated. 
  FilterContent(java.util.Locale l, Bundle b)
          creates a new FilterContent with the given locale and bundle.
  FilterContent(java.lang.String n, java.util.Locale l, Bundle b)
          creates a new FilterContent with the given name, locale and bundle.
  FilterContent(java.lang.String n, java.util.Locale l, Bundle b, Filter f)
          creates a new FilterContent with the given name, locale, bundle and filter.
 
Method Summary
 FilterContent createCopy(java.util.Locale l, User u)
          overrides Content.createCopy(Locale, User).
 org.jdom.Element deserializeToJDOM()
          a FilterContent deserialised to XML.
 Filter getFilter()
           
 boolean isGroup()
          Determines whether the Content is a group.
 void onVirtualFileSystemChange(VirtualFile file)
          Is called by the VirtualFileSystem, if any associated VirtualFiles have been moved in the file system.
 void removeFilter()
          removes the Filter from the FilterContent.
 void setFilter(Filter f)
           
 void updateAssociatedVirtualFiles()
          is called by the editors upon save actions to update the list of associated VirtualFiles.
 
Methods inherited from class org.torweg.pulse.site.content.AbstractBasicContent
deserializeToJDOM, getFullTextValue, getKeywords, getLinkCorrectables, getMetaDescription, getMetaKeywords, getSuffix, getSummary, getSummaryElement, getTitle, setKeywords, setMetaDescription, setMetaKeywords, setSuffix, setSummary, setTitle
 
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, processHTML, removeReferenceDuration, setAssociatedVirtualFiles, setAttachments, setBundle, setCreator, setLastModifier, setLocale, setLocalizationMap, setReferenceDuration, toString, 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
 

Constructor Detail

FilterContent

@Deprecated
protected FilterContent()
Deprecated. 

used by HibernateTM.


FilterContent

public FilterContent(java.lang.String n,
                     java.util.Locale l, Bundle b, Filter f)
creates a new FilterContent with the given name, locale, bundle and filter.

Parameters:
n - the name
l - the locale
b - the bundle
f - the filter

FilterContent

public FilterContent(java.lang.String n,
                     java.util.Locale l, Bundle b)
creates a new FilterContent with the given name, locale and bundle.

Parameters:
n - the name
l - the locale
b - the bundle

FilterContent

public FilterContent(java.util.Locale l, Bundle b)
creates a new FilterContent with the given locale and bundle.

A FilterContent created this way can only be saved after a name is set!

Parameters:
l - the locale
b - the bundle
Method Detail

getFilter

public final Filter getFilter()
Returns:
Returns the filter, Filter can be null.

setFilter

public final void setFilter(Filter f)
Parameters:
f - The filter to set.

removeFilter

public final void removeFilter()
removes the Filter from the FilterContent.


createCopy

public FilterContent createCopy(java.util.Locale l, User u)
Description copied from class: AbstractBasicContent
overrides Content.createCopy(Locale, User).

Specified by:
createCopy in class AbstractBasicContent
Parameters:
l - the locale to create the copy for
u - the User to be used as the creator/last modifier of the copied Content
Returns:
a copy of the FilterCotnent

isGroup

public boolean isGroup()
Description copied from class: Content
Determines whether the Content is a group.

A group is a Content generating its contents from its children in the Sitemap.

Specified by:
isGroup in class Content
Returns:
false
See Also:
Content.isGroup()

onVirtualFileSystemChange

public void onVirtualFileSystemChange(VirtualFile file)
Description copied from class: Content
Is called by the VirtualFileSystem, if any associated VirtualFiles have been moved in the file system.

Specified by:
onVirtualFileSystemChange in class Content
Parameters:
file - the VirtualFile that has changed
See Also:
Content.onVirtualFileSystemChange(VirtualFile)

updateAssociatedVirtualFiles

public void updateAssociatedVirtualFiles()
is called by the editors upon save actions to update the list of associated VirtualFiles.

Specified by:
updateAssociatedVirtualFiles in class Content

deserializeToJDOM

public org.jdom.Element deserializeToJDOM()
a FilterContent deserialised to XML.

TODO: show XML

Specified by:
deserializeToJDOM in interface JDOMable
Overrides:
deserializeToJDOM in class AbstractBasicContent
Returns:
&lt;Content/&gt;
See Also:
JDOMable.deserializeToJDOM()