org.turro.elephant.impl.abstracts.AbstractElement Class Reference

Inheritance diagram for org.turro.elephant.impl.abstracts.AbstractElement:

Collaboration diagram for org.turro.elephant.impl.abstracts.AbstractElement:

Public Member Functions
	AbstractElement ()
String	getId ()
String	getType ()
String	getTitle ()
void	setTitle (String title)
Collection< String >	getMetas ()
void	setMetas (Collection< String > metas)
ElContext	getContext ()
IConstructor	getConstructor ()
void	loadData () throws ServletException, IOException
abstract void	startConstruction () throws ServletException, IOException
void	setConfiguration (IConstructor constructor, ElContext context)
String	getStart ()
String	getEnd ()
String	getStartTitle ()
String	getEndTitle ()
String	getStartBody ()
String	getEndBody ()
String	getStartFooter ()
String	getEndFooter ()
String	getStartOption ()
String	getEndOption ()
boolean	canDisplay ()
boolean	isSelectable ()
boolean	isInRole ()
boolean	canPrint ()
String	getElementFolder ()
boolean	isOriginalContext ()
void	setRootCategories (ElContext root)
String	getTypeName ()
AttributeSupport	getAttributes ()
void	applyChanges ()
void	populateFromParent ()
void	setDefaultMetas ()
void	setConfiguration (Element conf, Element factory)

Protected Attributes
IConstructor	constructor
ElContext	context
AttributeSupport	attrSupport
Element	conf = null
String[]	types
String	title
Collection< String >	metas

Detailed Description

Author

Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 46 of file AbstractElement.java.

Constructor & Destructor Documentation

AbstractElement()

org.turro.elephant.impl.abstracts.AbstractElement.AbstractElement

(

)

Creates a new instance of AbstractElement

Definition at line 57 of file AbstractElement.java.

                           {
    attrSupport = new AttributeSupport();
  }

Member Function Documentation

applyChanges()

void org.turro.elephant.impl.abstracts.AbstractElement.applyChanges

(

)

Implements org.turro.elephant.layout.IManageable.

Definition at line 223 of file AbstractElement.java.

                             {
  }

canDisplay()

boolean org.turro.elephant.impl.abstracts.AbstractElement.canDisplay

(

)

This method is queried within startConstruction().

Returns

True is element can display.

Implements org.turro.elephant.security.IDefendable.

Definition at line 174 of file AbstractElement.java.

                              {
    return isSelectable();
  }

Here is the call graph for this function:

canPrint()

boolean org.turro.elephant.impl.abstracts.AbstractElement.canPrint

(

)

This method is queried when a print version is being called.

Returns

True is element can print.

Implements org.turro.elephant.security.IDefendable.

Definition at line 192 of file AbstractElement.java.

                            {
    return true;
  }

getAttributes()

AttributeSupport org.turro.elephant.impl.abstracts.AbstractElement.getAttributes

(

)

Returns

The attributes of this element.

Implements org.turro.elephant.layout.IManageable.

Definition at line 218 of file AbstractElement.java.

                                          {
    return attrSupport;
  }

Here is the caller graph for this function:

getConstructor()

IConstructor org.turro.elephant.impl.abstracts.AbstractElement.getConstructor

(

)

Returns

Returns current IConstructor.

Implements org.turro.elephant.context.IElement.

Definition at line 97 of file AbstractElement.java.

                                       {
    return constructor;
  }

Here is the caller graph for this function:

getContext()

ElContext org.turro.elephant.impl.abstracts.AbstractElement.getContext

(

)

Returns

The ElContext owning the element.

Implements org.turro.elephant.context.IElement.

Definition at line 92 of file AbstractElement.java.

                                {
    return context;
  }

Here is the caller graph for this function:

getElementFolder()

String org.turro.elephant.impl.abstracts.AbstractElement.getElementFolder

(

)

IElement implementations must ensure this folder is unique within the web application.

Returns

Element's folder.

Implements org.turro.elephant.context.IElement.

Definition at line 197 of file AbstractElement.java.

                                   {
    return context.getPath();
  }

Here is the call graph for this function:

getEnd()

String org.turro.elephant.impl.abstracts.AbstractElement.getEnd

(

)

Implements org.turro.elephant.layout.IRenderable.

Reimplemented in org.turro.elephant.search.Search, org.turro.elephant.impl.feed.RssReader, org.turro.elephant.impl.context.DefaultElement, org.turro.dashboard.AbstractDaoDashboard, org.turro.dashboard.AbstractDashboard, org.turro.agreements.MyAgreementsDashboard, org.turro.publication.www.PublicationWeb, org.turro.newsletter.NewsletterDashboard, org.turro.dossier.www.PendingRevisionDashboard, org.turro.dossier.www.MyIssuesDashboard, org.turro.dossier.www.KnowledgeBaseDashboard, org.turro.contacts.www.MyContactsDashboard, and org.turro.financials.cart.www.LogisticDashboard.

Definition at line 120 of file AbstractElement.java.

                         {
    return "";
  }

getEndBody()

String org.turro.elephant.impl.abstracts.AbstractElement.getEndBody

(

)

Implements org.turro.elephant.layout.IRenderable.

Definition at line 145 of file AbstractElement.java.

                             {
    String result = "";
    for(int i = 0; types != null && i < types.length; i++) {
      result += "</div>";
    }
    return result;
  }

Here is the caller graph for this function:

getEndFooter()

String org.turro.elephant.impl.abstracts.AbstractElement.getEndFooter

(

)

Implements org.turro.elephant.layout.IRenderable.

Definition at line 159 of file AbstractElement.java.

                               {
    return "";
  }  

getEndOption()

String org.turro.elephant.impl.abstracts.AbstractElement.getEndOption

(

)

Implements org.turro.elephant.layout.IRenderable.

Definition at line 169 of file AbstractElement.java.

                               {
    return "";
  }  

getEndTitle()

String org.turro.elephant.impl.abstracts.AbstractElement.getEndTitle

(

)

Implements org.turro.elephant.layout.IRenderable.

Definition at line 130 of file AbstractElement.java.

                              {
    return "";
  }

getId()

String org.turro.elephant.impl.abstracts.AbstractElement.getId

(

)

Returns

Element's identifier.

Implements org.turro.elephant.context.IElement.

Definition at line 62 of file AbstractElement.java.

                        {
    return (this instanceof DefaultElement) ? null : this.getClass().getSimpleName();
  }

Here is the caller graph for this function:

getMetas()

Collection<String> org.turro.elephant.impl.abstracts.AbstractElement.getMetas

(

)

Implements org.turro.elephant.context.IElement.

Definition at line 82 of file AbstractElement.java.

                                       {
    return metas == null ? Collections.EMPTY_LIST : metas;
  }

getStart()

String org.turro.elephant.impl.abstracts.AbstractElement.getStart

(

)

Implements org.turro.elephant.layout.IRenderable.

Reimplemented in org.turro.elephant.search.Search, org.turro.elephant.impl.feed.RssReader, org.turro.elephant.impl.context.DefaultElement, org.turro.dashboard.AbstractDaoDashboard, org.turro.dashboard.AbstractDashboard, org.turro.agreements.MyAgreementsDashboard, org.turro.publication.www.PublicationWeb, org.turro.newsletter.NewsletterDashboard, org.turro.dossier.www.PendingRevisionDashboard, org.turro.dossier.www.MyIssuesDashboard, org.turro.dossier.www.KnowledgeBaseDashboard, org.turro.contacts.www.MyContactsDashboard, and org.turro.financials.cart.www.LogisticDashboard.

Definition at line 115 of file AbstractElement.java.

                           {
    return "";
  }

getStartBody()

String org.turro.elephant.impl.abstracts.AbstractElement.getStartBody

(

)

Implements org.turro.elephant.layout.IRenderable.

Definition at line 135 of file AbstractElement.java.

                               {
    initTypes();
    String result = "";
    for(int i = 0; types != null && i < types.length; i++) {
      result += "<div class='" + types[i] + "'>";
    }
    return result;
  }

Here is the caller graph for this function:

getStartFooter()

String org.turro.elephant.impl.abstracts.AbstractElement.getStartFooter

(

)

Implements org.turro.elephant.layout.IRenderable.

Definition at line 154 of file AbstractElement.java.

                                 {
    return "";
  }

getStartOption()

String org.turro.elephant.impl.abstracts.AbstractElement.getStartOption

(

)

Implements org.turro.elephant.layout.IRenderable.

Definition at line 164 of file AbstractElement.java.

                                 {
    return "";
  }

getStartTitle()

String org.turro.elephant.impl.abstracts.AbstractElement.getStartTitle

(

)

Implements org.turro.elephant.layout.IRenderable.

Definition at line 125 of file AbstractElement.java.

                                {
    return "";
  }

getTitle()

String org.turro.elephant.impl.abstracts.AbstractElement.getTitle

(

)

Implements org.turro.elephant.context.IElement.

Definition at line 72 of file AbstractElement.java.

                           {
    return title;
  }

getType()

String org.turro.elephant.impl.abstracts.AbstractElement.getType

(

)

Implements org.turro.elephant.context.IElement.

Definition at line 67 of file AbstractElement.java.

                          {
    return attrSupport.getAttributeValue("type", "default-element");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getTypeName()

String org.turro.elephant.impl.abstracts.AbstractElement.getTypeName

(

)

Returns

Element type name.

Implements org.turro.elephant.layout.IManageable.

Definition at line 213 of file AbstractElement.java.

                              {
    return I_.get("element." + getType());
  }

Here is the call graph for this function:

isInRole()

boolean org.turro.elephant.impl.abstracts.AbstractElement.isInRole

(

)

This method points to an specific role, know at configuration time. To achieve more control on roles use constructor's, which takes a parameter with a role.

Returns

True when the element is in role.

Implements org.turro.elephant.security.IDefendable.

Definition at line 184 of file AbstractElement.java.

                            {
    if(Strings.isBlank(context.getWebContext().getElement().getRole())) {
      return true;
    }
    return constructor.isInRole(context.getWebContext().getElement().getRole());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

isOriginalContext()

boolean org.turro.elephant.impl.abstracts.AbstractElement.isOriginalContext

(

)

Returns

True if current context is the original context where this element was created.

Implements org.turro.elephant.context.IElement.

Definition at line 202 of file AbstractElement.java.

                                     {
    return getConstructor().isOriginal();
    //return context.getPath().equals(getConstructor().getCurrentContext().getPath());
  }

Here is the call graph for this function:

isSelectable()

boolean org.turro.elephant.impl.abstracts.AbstractElement.isSelectable

(

)

Selectable elements may respond to user input.

Returns

True when the element is selectable.

Implements org.turro.elephant.security.IDefendable.

Definition at line 179 of file AbstractElement.java.

                                {
    return isInRole();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

loadData()

void org.turro.elephant.impl.abstracts.AbstractElement.loadData

(

)

throws ServletException, IOException

This method loads element's data. It gets called within IConstructor.startConstruction() and before element's startConstruction() method.

Exceptions

javax.servlet.ServletException
java.io.IOException

Implements org.turro.elephant.context.IElement.

Reimplemented in org.turro.elephant.impl.context.DefaultElement, org.turro.dashboard.AbstractDaoDashboard, org.turro.dashboard.AbstractDashboard, org.turro.agreements.MyAgreementsDashboard, org.turro.publication.www.PublicationWeb, org.turro.newsletter.NewsletterDashboard, org.turro.dossier.www.PendingRevisionDashboard, org.turro.dossier.www.MyIssuesDashboard, org.turro.dossier.www.KnowledgeBaseDashboard, org.turro.contacts.www.MyContactsDashboard, and org.turro.financials.cart.www.LogisticDashboard.

Definition at line 102 of file AbstractElement.java.

                                                              {
  }

populateFromParent()

void org.turro.elephant.impl.abstracts.AbstractElement.populateFromParent

(

)

Implements org.turro.elephant.layout.IManageable.

Definition at line 227 of file AbstractElement.java.

                                   {
  }

setConfiguration() [1/2]

void org.turro.elephant.impl.abstracts.AbstractElement.setConfiguration	(	Element	conf,
		Element	factory
	)

Definition at line 251 of file AbstractElement.java.

                                                              {
    this.conf = conf;
    this.factory = factory;
    attrSupport.addAttribute(new AttributeItem("type", 
            (conf != null ? conf.getAttributeValue("type") : null), AttributeItem.STRING_ATTR, "default-body"));
    if(conf != null) {
      List attribs = conf.getChildren("attrib");
      Iterator it = attribs.iterator();
      Element tmp;
      while(it.hasNext()) {
        tmp = (Element)it.next();
        attrSupport.addAttribute(new AttributeItem(
                "attrib:" + tmp.getAttributeValue("name"), 
                tmp.getAttributeValue("value"), 
                AttributeItem.STRING_ATTR,
                null));
      }
    }
  }

Here is the call graph for this function:

setConfiguration() [2/2]

void org.turro.elephant.impl.abstracts.AbstractElement.setConfiguration	(	IConstructor	constructor,
		ElContext	context
	)

Implements org.turro.elephant.context.IElement.

Definition at line 109 of file AbstractElement.java.

                                                                            {
    this.constructor = constructor;
    this.context = context;
  }

setDefaultMetas()

void org.turro.elephant.impl.abstracts.AbstractElement.setDefaultMetas

(

)

Definition at line 230 of file AbstractElement.java.

                                {
    ArrayList<RepositoryFile> files = new ArrayList<>();
    //ElContext elContext = ElContextMap.getContext(context);
    if(context != null) { 
      if(!SocialImageMap.hasImage(context.getWebPath())) {
        Repository repository = context.getRepository();
        files.addAll(repository.getRepositoryFiles("*_social.png,*_social.jpg"));
        files.addAll(repository.getRepositoryFiles("*.png,*.jpg"));
      }
      setMetas(new SocialNet(context.getWebPath(), context.getName(), null, files).getMetas());
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

setMetas()

void org.turro.elephant.impl.abstracts.AbstractElement.setMetas

(

Collection< String >

metas

)

Implements org.turro.elephant.context.IElement.

Definition at line 87 of file AbstractElement.java.

                                                 {
    this.metas = metas;
  }

Here is the caller graph for this function:

setRootCategories()

void org.turro.elephant.impl.abstracts.AbstractElement.setRootCategories

(

ElContext

root

)

Parameters

root	Categories root Calls

Implements org.turro.elephant.context.IElement.

Reimplemented in org.turro.publication.www.PublicationWeb, and org.turro.dossier.www.DossierDashboard.

Definition at line 208 of file AbstractElement.java.

                                                {
    // do nothing
  }

setTitle()

void org.turro.elephant.impl.abstracts.AbstractElement.setTitle

(

String

title

)

Implements org.turro.elephant.context.IElement.

Definition at line 77 of file AbstractElement.java.

                                     {
    this.title = title;
  }

Here is the caller graph for this function:

startConstruction()

abstract void org.turro.elephant.impl.abstracts.AbstractElement.startConstruction ( ) throws ServletException, IOException

abstract

This method start element's construction. It gets called within IConstructor.startConstruction().

Exceptions

javax.servlet.ServletException
java.io.IOException

Implements org.turro.elephant.context.IElement.

Reimplemented in org.turro.elephant.search.Search, org.turro.elephant.impl.feed.RssReader, org.turro.elephant.impl.context.DefaultElement, org.turro.dashboard.AbstractDaoDashboard, org.turro.web.funnel.FunnelDashboard, org.turro.dashboard.AbstractDashboard, org.turro.agreements.MyAgreementsDashboard, org.turro.publication.www.PublicationWeb, org.turro.newsletter.NewsletterDashboard, org.turro.dossier.www.PendingRevisionDashboard, org.turro.dossier.www.MyIssuesDashboard, org.turro.dossier.www.KnowledgeBaseDashboard, org.turro.dossier.www.DossierDashboard, org.turro.contacts.www.MyContactsDashboard, and org.turro.financials.cart.www.LogisticDashboard.

Member Data Documentation

attrSupport

AttributeSupport org.turro.elephant.impl.abstracts.AbstractElement.attrSupport

protected

Definition at line 50 of file AbstractElement.java.

conf

Element org.turro.elephant.impl.abstracts.AbstractElement.conf = null

protected

Definition at line 51 of file AbstractElement.java.

constructor

IConstructor org.turro.elephant.impl.abstracts.AbstractElement.constructor

protected

Definition at line 48 of file AbstractElement.java.

context

ElContext org.turro.elephant.impl.abstracts.AbstractElement.context

protected

Definition at line 49 of file AbstractElement.java.

metas

Collection<String> org.turro.elephant.impl.abstracts.AbstractElement.metas

protected

Definition at line 54 of file AbstractElement.java.

title

String org.turro.elephant.impl.abstracts.AbstractElement.title

protected

Definition at line 53 of file AbstractElement.java.

types

String [] org.turro.elephant.impl.abstracts.AbstractElement.types

protected

Definition at line 52 of file AbstractElement.java.

---

The documentation for this class was generated from the following file:

• AbstractElement.java