Inheritance diagram for org.turro.entities.ElephantEntities:

Collaboration diagram for org.turro.entities.ElephantEntities:

[legend]

Public Member Functions
	ElephantEntities ()

	ElephantEntities (String entityPath)

	ElephantEntities (Object entity)

Object	getEntity ()

String	getName ()

String	getLabel ()

String	getDescription ()

Object	getLabelCtrl ()

String	getImage ()

String	getHierarchicalPath ()

IElephantEntity	getParent ()

List< IElephantEntity >	getChildren ()

String	getExtendedPath ()

File	getFile ()

boolean	showPath ()

boolean	showEntity ()

boolean	canEdit (IContact contact)

boolean	canPublish (IContact contact)

Collection	getEntitites (String search, int maxResults, KeyValueMap kvm)

Collection	getEntitites (String root, String search, int maxResults, KeyValueMap kvm)

Object	configureCtrl (Object ctrl, IContact contact)

boolean	canShowInContext (IContact contact, Object relatedEntity)

String	getExtendedWebPath ()

String	getUserContext ()

Collection< String >	getAllowedRoots ()

Object	getObject (Path entityPath)

String	getEntityUrl (LinkType type, String contextPath)

Public Member Functions inherited from org.turro.entities.DefaultElephantEntity
	DefaultElephantEntity ()

	DefaultElephantEntity (String entityPath)

	DefaultElephantEntity (Object entity)

IElephantEntity	getController (String entityPath)

IElephantEntity	getController (Object entity)

boolean	isEmpty ()

String	getStringId ()

String	getNameOrLabel ()

String	getRoot ()

String	getPath ()

String	getTreeLabel ()

Collection	getEntitites (String search, int maxResults)

Collection	getEntitites (String root, String search, int maxResults)

IElephantSendable	getSendable ()

Collection< Object >	getRelatedByRole (EntityRole role, IContact contact)

boolean	hasRelatedRole (EntityRole role, IContact contact)

String	getLinkRoot ()

String	getEntityUrl ()

String	getMemberUrl ()

String	getAppUrl ()

String	getReadAllUrl (LinkType type, String contextPath)

Object	getControl (String name, IContact contact)

Object	getControl (String name, IConstructor constructor, IContact contact)

Object	getControl (String name, String entityPath, IContact contact)

Object	getParticipationControl (IConstructor constructor, ParticipationReason reason)

Object	getParticipationControl (IConstructor constructor, IContact contact, ParticipationReason reason)

String	parseSpamCtrl (IConstructor constructor)

String	parseFollowCtrl (IConstructor constructor)

EntitySet	getAllChildren ()

Script	getActorScript ()

boolean	isActor (String actor)

boolean	isActor (IContact contact, String actor)

ConceptPermission	getConceptPermission (String name)

Folder	getDeliverables ()

IElephantEntity	getMain (Object entity)

int	hashCode ()

boolean	equals (Object obj)

Protected Member Functions
Dao	createDao ()

boolean	itsMine (Object entity)

IElephantEntity	createInstance (String entityPath)

IElephantEntity	createInstance (Object entity)

Path	createPath ()

Protected Member Functions inherited from org.turro.entities.DefaultElephantEntity
boolean	itsMine (String rootPath)

boolean	isValidLongEntity ()

Dao	getDao ()

Additional Inherited Members
Static Public Attributes inherited from org.turro.entities.IElephantEntity
static final String	EMPTY_ID = "#"

static final String	PATH_SEPARATOR = ";"

Protected Attributes inherited from org.turro.entities.DefaultElephantEntity
String	entityPath

Path	path

Object	entity

Detailed Description

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

Definition at line 51 of file ElephantEntities.java.

Constructor & Destructor Documentation

◆ ElephantEntities() [1/3]

org.turro.entities.ElephantEntities.ElephantEntities ( )

Definition at line 53 of file ElephantEntities.java.

53 {

54 }

Here is the caller graph for this function:

◆ ElephantEntities() [2/3]

org.turro.entities.ElephantEntities.ElephantEntities ( String entityPath )

Definition at line 56 of file ElephantEntities.java.

                                              {
     super(entityPath);
   }

◆ ElephantEntities() [3/3]

org.turro.entities.ElephantEntities.ElephantEntities ( Object entity )

Definition at line 60 of file ElephantEntities.java.

                                          {
     super(entity);
   }

Member Function Documentation

◆ canEdit()

boolean org.turro.entities.ElephantEntities.canEdit ( IContact contact )

Checks when contact has permissions to edit the entity.

Parameters

contact the contact checked.

Returns: true when the contact can edit.

Implements org.turro.entities.IElephantEntity.

Definition at line 237 of file ElephantEntities.java.

                                            {
     return false;
   }

◆ canPublish()

boolean org.turro.entities.ElephantEntities.canPublish ( IContact contact )

Checks when contact has permissions to see the entity.

Parameters

contact the contact checked.

Returns: true when the contact can see.

Implements org.turro.entities.IElephantEntity.

Definition at line 242 of file ElephantEntities.java.

                                               {
     if(getEntity() != null) {
       if(entity instanceof Poll) {
         return ((Poll) entity).isParticipant(contact);
       }
     }
     return false;
   }

Here is the call graph for this function:

◆ canShowInContext()

boolean org.turro.entities.ElephantEntities.canShowInContext	(	IContact	contact,
		Object	relatedEntity
	)

Checks whether the related entity can be shown to the given contact.

Parameters

contact	the contact to be checked against.
relatedEntity	the related entity to be shown.

Returns: true if can be shown.

Implements org.turro.entities.IElephantEntity.

Definition at line 277 of file ElephantEntities.java.

                                                                           {
     return true;
   }

◆ configureCtrl()

Object org.turro.entities.ElephantEntities.configureCtrl	(	Object	ctrl,
		IContact	contact
	)

Configures specific entity related controls for the given contact.

Parameters

ctrl	the control to configure.
contact	the contact who receive the control.

Returns: the configured control.

Implements org.turro.entities.IElephantEntity.

Definition at line 272 of file ElephantEntities.java.

                                                              {
     return ctrl;
   }

◆ createDao()

Dao org.turro.entities.ElephantEntities.createDao ( )

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 306 of file ElephantEntities.java.

                             {
     return new ElephantPU();
   }

◆ createInstance() [1/2]

IElephantEntity org.turro.entities.ElephantEntities.createInstance ( Object entity )

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 327 of file ElephantEntities.java.

                                                           {
     return new ElephantEntities(entity);
   }

Here is the call graph for this function:

◆ createInstance() [2/2]

IElephantEntity org.turro.entities.ElephantEntities.createInstance ( String entityPath )

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 322 of file ElephantEntities.java.

                                                               {
     return new ElephantEntities(entityPath);
   }

Here is the call graph for this function:

◆ createPath()

Path org.turro.entities.ElephantEntities.createPath ( )

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 332 of file ElephantEntities.java.

                               {
     return new Path(ElephantPU.getObjectPath(entity));
   }

Here is the call graph for this function:

◆ getAllowedRoots()

Collection<String> org.turro.entities.ElephantEntities.getAllowedRoots ( )

Implements org.turro.entities.IElephantEntity.

Definition at line 317 of file ElephantEntities.java.

                                               {
     return Arrays.asList("sendable", "poll", "topic", "post");
   }

◆ getChildren()

List<IElephantEntity> org.turro.entities.ElephantEntities.getChildren ( )

Gets the children for this entity.

Returns: the children controllers.

Implements org.turro.entities.IElephantEntity.

Definition at line 205 of file ElephantEntities.java.

                                              {
     if(getEntity() != null) {
       if(entity instanceof Topic) {
         return new EntityListAdapter(((Topic) entity).getPosts());
       } else if(entity instanceof Post) {
         return new EntityListAdapter(((Post) entity).getPosts());
       }
     }
     return Collections.EMPTY_LIST;
   }

Here is the call graph for this function:

◆ getDescription()

String org.turro.entities.ElephantEntities.getDescription ( )

Gets the entity description.

Returns: the description string.

Implements org.turro.entities.IElephantEntity.

Definition at line 139 of file ElephantEntities.java.

                                  {
     return null;
   }

◆ getEntitites() [1/2]

Collection org.turro.entities.ElephantEntities.getEntitites	(	String	root,
		String	search,
		int	maxResults,
		KeyValueMap	kvm
	)

Implements org.turro.entities.IElephantEntity.

Definition at line 259 of file ElephantEntities.java.

                                                                                               {
     ArrayList<Object> list = new ArrayList<>();
     if(null != root) switch (root) {
       case "poll":
         list.addAll(searchPolls(search, maxResults, kvm));
         break;
       default:
         break;
     }
     return list;
   }

◆ getEntitites() [2/2]

Collection org.turro.entities.ElephantEntities.getEntitites	(	String	search,
		int	maxResults,
		KeyValueMap	kvm
	)

Implements org.turro.entities.IElephantEntity.

Definition at line 252 of file ElephantEntities.java.

                                                                                  {
     ArrayList<Object> list = new ArrayList<>();
     list.addAll(searchPolls(search, maxResults, kvm));
     return list;
   }

◆ getEntity()

Object org.turro.entities.ElephantEntities.getEntity ( )

Returns the entity for this controller.

Returns: the entity's object.

Implements org.turro.entities.IElephantEntity.

Definition at line 65 of file ElephantEntities.java.

                             {
     if(entity == null) {
       if(getPath() != null) {
         if(path.getSize() == 2) {
           if(null != path.getRoot()) switch (path.getRoot()) {
             case "sendable":
               if(isValidLongEntity()) {
                 entity = getDao().find(Sendable.class, path.getFrom(1));
               }
               break;                
             case "poll":
               if(isValidLongEntity()) {
                 entity = getDao().find(Poll.class, path.getNodeAs(1, Long.class));
               }
               break;                
             case "topic":
               if(isValidLongEntity()) {
                 entity = getDao().find(Topic.class, path.getNodeAs(1, Long.class));
               }
               break;                
             case "post":
               if(isValidLongEntity()) {
                 entity = getDao().find(Post.class, path.getNodeAs(1, Long.class));
               }
               break;                
             default:
               break;
           }
         }
       }
     }
     return entity;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEntityUrl()

String org.turro.entities.ElephantEntities.getEntityUrl	(	LinkType	type,
		String	contextPath
	)

Returns the web link for this entity.

Parameters

type	web, member or app.
contextPath	if specified, will be used instead of defaults.

Returns: the path string.

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 354 of file ElephantEntities.java.

                                                                 {
     if("post".equals(getRoot())) {
       return getParent().getEntityUrl(type, contextPath);
     }
     return super.getEntityUrl(type, contextPath);
   }

Here is the call graph for this function:

◆ getExtendedPath()

String org.turro.entities.ElephantEntities.getExtendedPath ( )

Gets the extended path for this entity.

Returns: the extended path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 217 of file ElephantEntities.java.

                                   {
     return null;
   }

◆ getExtendedWebPath()

String org.turro.entities.ElephantEntities.getExtendedWebPath ( )

Returns a unique path for the entity.

Returns: the path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 282 of file ElephantEntities.java.

                                      {
     if(getEntity() != null) {
       if(entity instanceof Poll) {
         Poll poll = (Poll) entity;
         return "/" + poll.getId() + 
                 "/" + Strings.unpunctuate(poll.getTitle()).toLowerCase();
       }
     }
     return null;
   }

Here is the call graph for this function:

◆ getFile()

File org.turro.entities.ElephantEntities.getFile ( )

Gets the file represented by the entity.

Returns: the entity file.

Implements org.turro.entities.IElephantEntity.

Definition at line 222 of file ElephantEntities.java.

                         {
     return null;
   }

◆ getHierarchicalPath()

String org.turro.entities.ElephantEntities.getHierarchicalPath ( )

Gets the hierarchical path for this entity. Mostly used for sorting purposes.

Returns: the hierarchical path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 169 of file ElephantEntities.java.

                                       {
     if(getEntity() != null) {
       if(entity instanceof Poll) {
         IElephantEntity iee = ((Poll) entity).getEntity();
         String hp = iee.getHierarchicalPath();
         return (Strings.isBlank(hp) ? "" : hp + PATH_SEPARATOR) + getPath();
       } else if(entity instanceof Topic) {
         IElephantEntity iee = ((Topic) entity).getEntity();
         String hp = iee.getHierarchicalPath();
         return (Strings.isBlank(hp) ? "" : hp + PATH_SEPARATOR) + getPath();
       } else if(entity instanceof Post) {
         IElephantEntity iee = ((Post) entity).getTopic().getEntity();
         String hp = iee.getHierarchicalPath();
         return (Strings.isBlank(hp) ? "" : hp + PATH_SEPARATOR) + getPath();
       }
     }
     return getPath();
   }

Here is the call graph for this function:

◆ getImage()

String org.turro.entities.ElephantEntities.getImage ( )

Gets the entity image based on its root.

Returns: the string image location.

Implements org.turro.entities.IElephantEntity.

Definition at line 149 of file ElephantEntities.java.

                            {
     if(getPath() != null) {
       String root = path.getRoot();
       if(null != root) switch (root) {
         case "sendable":
           return "/_zul/images/mail_queue.png";
         case "poll":
           return "/_zul/images/poll.png";
         case "topic":
           return "/_zul/images/topic.png";
         case "post":
           return "/_zul/images/topic.png";
         default:
           break;
       }
     }
     return null;
   }

Here is the call graph for this function:

◆ getLabel()

String org.turro.entities.ElephantEntities.getLabel ( )

Gets the entity label, based on its root.

Returns: the entity string label.

Implements org.turro.entities.IElephantEntity.

Definition at line 119 of file ElephantEntities.java.

                            {
     if(getPath() != null) {
       String root = path.getRoot();
       if(null != root) switch (root) {
         case "sendable":
           return I_.get("Sendable");
         case "poll":
           return I_.get("Poll");
         case "topic":
           return I_.get("Topic");
         case "post":
           return I_.get("Post");
         default:
           break;
       }
     }
     return null;
   }

Here is the call graph for this function:

◆ getLabelCtrl()

Object org.turro.entities.ElephantEntities.getLabelCtrl ( )

Gets the label control, usually a clickable LabelControl class.

Returns: a clickable label control.

Implements org.turro.entities.IElephantEntity.

Definition at line 144 of file ElephantEntities.java.

                                {
     return null;
   }

◆ getName()

String org.turro.entities.ElephantEntities.getName ( )

Gets the entity name.

Returns: the string name.

Implements org.turro.entities.IElephantEntity.

Definition at line 100 of file ElephantEntities.java.

                           {
     if(getEntity() != null) {
       if(entity instanceof Sendable) {
         return DateFormats.format(
                 ((Sendable) entity).getSchedule(),
                 DateFormat.SHORT, DateFormat.SHORT, 
                 I_.api().used());
       } else if(entity instanceof Poll) {
         return ((Poll) entity).getTitle();
       } else if(entity instanceof Topic) {
         return ((Topic) entity).getText();
       } else if(entity instanceof Post) {
         return ((Post) entity).getText();
       }
     }
     return null;
   }

Here is the call graph for this function:

◆ getObject()

Object org.turro.entities.ElephantEntities.getObject ( Path entityPath )

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 337 of file ElephantEntities.java.

                                            {
     if("entity-participation".equals(entityPath.getRoot())) {
       return getDao().find(EntityParticipation.class, EntityParticipationPK.from(entityPath.getComplex(1)));
     }
     return null;
   }

Here is the call graph for this function:

◆ getParent()

IElephantEntity org.turro.entities.ElephantEntities.getParent ( )

Gets the parent for this entity.

Returns: the parent controller.

Implements org.turro.entities.IElephantEntity.

Definition at line 189 of file ElephantEntities.java.

                                      {
     if(getEntity() != null) {
       if(entity instanceof Sendable) {
         return (IElephantEntity) ((Sendable) entity).getEntity();
       } else if(entity instanceof Poll) {
         return ((Poll) entity).getEntity();
       } else if(entity instanceof Topic) {
         return ((Topic) entity).getEntity();
       } else if(entity instanceof Post) {
         return Entities.getController(((Post) entity).getParentTopic());
       }
     }
     return null;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserContext()

String org.turro.entities.ElephantEntities.getUserContext ( )

Returns the user context for this type of entity

Returns: the path string;

Implements org.turro.entities.IElephantEntity.

Definition at line 294 of file ElephantEntities.java.

                                  {
     getPath();
     if(path.getRoot().equals("poll")) {
       return "/user/mypolls";
     }
     if(path.getRoot().equals("topic")) {
       return "/user/forums";
     }
     return null;
   }

Here is the call graph for this function:

◆ itsMine()

boolean org.turro.entities.ElephantEntities.itsMine ( Object entity )

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 311 of file ElephantEntities.java.

                                            {
     return (entity instanceof Sendable) || (entity instanceof Poll) ||
            (entity instanceof Topic) || (entity instanceof Post);
   }

◆ showEntity()

boolean org.turro.entities.ElephantEntities.showEntity ( )

Shows the view for the entity.

Returns: true when a view is shown.

Implements org.turro.entities.IElephantEntity.

Definition at line 232 of file ElephantEntities.java.

                               {
     return false;
   }

◆ showPath()

boolean org.turro.entities.ElephantEntities.showPath ( )

Shows the view for this path.

Returns: true when a view is shown.

Implements org.turro.entities.IElephantEntity.

Definition at line 227 of file ElephantEntities.java.

                             {
     return false;
   }

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

ElephantEntities.java

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ElephantEntities() [1/3]

◆ ElephantEntities() [2/3]

◆ ElephantEntities() [3/3]

Member Function Documentation

◆ canEdit()

◆ canPublish()

◆ canShowInContext()

◆ configureCtrl()

◆ createDao()

◆ createInstance() [1/2]

◆ createInstance() [2/2]

◆ createPath()

◆ getAllowedRoots()

◆ getChildren()

◆ getDescription()

◆ getEntitites() [1/2]

◆ getEntitites() [2/2]

◆ getEntity()

◆ getEntityUrl()

◆ getExtendedPath()

◆ getExtendedWebPath()

◆ getFile()

◆ getHierarchicalPath()

◆ getImage()

◆ getLabel()

◆ getLabelCtrl()

◆ getName()

◆ getObject()

◆ getParent()

◆ getUserContext()

◆ itsMine()

◆ showEntity()

◆ showPath()