Inheritance diagram for org.turro.entities.AttachEntities:

Collaboration diagram for org.turro.entities.AttachEntities:

[legend]

Public Member Functions
	AttachEntities ()

	AttachEntities (String entityPath)

	AttachEntities (Object entity)

Object	getEntity ()

String	getName ()

String	getLabel ()

String	getDescription ()

Object	getLabelCtrl ()

String	getImage ()

String	getMimeImage ()

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 ()

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	getEntityUrl (LinkType type, String contextPath)

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 ()

Object	getObject (Path entityPath)

IElephantEntity	getMain (Object entity)

int	hashCode ()

boolean	equals (Object obj)

Protected Member Functions
Dao	createDao ()

boolean	itsMine (String rootPath)

boolean	itsMine (Object entity)

IElephantEntity	createInstance (String entityPath)

IElephantEntity	createInstance (Object entity)

Path	createPath ()

Protected Member Functions inherited from org.turro.entities.DefaultElephantEntity
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 52 of file AttachEntities.java.

Constructor & Destructor Documentation

◆ AttachEntities() [1/3]

org.turro.entities.AttachEntities.AttachEntities ( )

Definition at line 54 of file AttachEntities.java.

54 {

55 }

Here is the caller graph for this function:

◆ AttachEntities() [2/3]

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

Definition at line 57 of file AttachEntities.java.

                                            {
     super(entityPath);
   }

◆ AttachEntities() [3/3]

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

Definition at line 61 of file AttachEntities.java.

                                        {
     super(entity);
   }

Member Function Documentation

◆ canEdit()

boolean org.turro.entities.AttachEntities.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 227 of file AttachEntities.java.

                                            {
     if(getEntity() != null) {
       if(entity instanceof Attachment) {
         return contact.getPermissions().isInRole("attach:list");
       } else if(entity instanceof File) {
         return contact.getPermissions().isInRole("file-attach:list");
       }
     }
     return false;
   }

Here is the call graph for this function:

◆ canPublish()

boolean org.turro.entities.AttachEntities.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 239 of file AttachEntities.java.

                                               {
     if(getEntity() != null) {
       if(entity instanceof Attachment) {
         Attachment attachment = (Attachment) entity;
         return contact.getPermissions().isInRole("attach-show:all") ||
                 (
                   attachment.isPublishable() &&
                   ((
                     attachment.isRequiresAcceptance() && 
                     attachment.getSingleStatus(contact).equals(AcceptanceSingleStatus.SINGLE_ACCEPTED)
                   ) || !attachment.isRequiresAcceptance())
                 );
       } else if(entity instanceof File) {
         return true; // Controlled by owner entity
       }
     }
     return false;
   }

Here is the call graph for this function:

◆ canShowInContext()

boolean org.turro.entities.AttachEntities.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 284 of file AttachEntities.java.

                                                                           {
     return true;
   }

◆ configureCtrl()

Object org.turro.entities.AttachEntities.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 279 of file AttachEntities.java.

                                                              {
     return ctrl;
   }

◆ createDao()

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

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 299 of file AttachEntities.java.

                             {
     return new AttachPU();
   }

◆ createInstance() [1/2]

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

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 324 of file AttachEntities.java.

                                                           {
     return new AttachEntities(entity);
   }

Here is the call graph for this function:

◆ createInstance() [2/2]

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

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 319 of file AttachEntities.java.

                                                               {
     return new AttachEntities(entityPath);
   }

Here is the call graph for this function:

◆ createPath()

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

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 329 of file AttachEntities.java.

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

Here is the call graph for this function:

◆ getAllowedRoots()

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

Implements org.turro.entities.IElephantEntity.

Definition at line 314 of file AttachEntities.java.

                                               {
     return Arrays.asList("attachment", "file");
   }

◆ getChildren()

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

Gets the children for this entity.

Returns: the children controllers.

Implements org.turro.entities.IElephantEntity.

Definition at line 180 of file AttachEntities.java.

                                              {
     return Collections.EMPTY_LIST;
   }

◆ getDescription()

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

Gets the entity description.

Returns: the description string.

Implements org.turro.entities.IElephantEntity.

Definition at line 117 of file AttachEntities.java.

                                  {
     return null;
   }

◆ getEntitites() [1/2]

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

Implements org.turro.entities.IElephantEntity.

Definition at line 266 of file AttachEntities.java.

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

◆ getEntitites() [2/2]

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

Implements org.turro.entities.IElephantEntity.

Definition at line 259 of file AttachEntities.java.

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

◆ getEntity()

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

Returns the entity for this controller.

Returns: the entity's object.

Implements org.turro.entities.IElephantEntity.

Definition at line 66 of file AttachEntities.java.

                             {
     if(entity == null) {
       if(getPath() != null) {
         if(path.getSize() == 2) {
           if(null != path.getRoot()) switch (path.getRoot()) {
             case "attachment":
               if(isValidLongEntity()) {
                 entity = getDao().find(Attachment.class, path.getNodeAs(1, Long.class));
               }
               break;                
             case "file":
               entity = new File(ElephantContext.getRealPath(path.getFrom(1)));
               break;
             default:
               break;
           }
         }
       }
     }
     return entity;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExtendedPath()

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

Gets the extended path for this entity.

Returns: the extended path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 185 of file AttachEntities.java.

                                   {
     return AttachPU.getObjectExtendedPath(entity);
   }

Here is the call graph for this function:

◆ getExtendedWebPath()

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

Returns a unique path for the entity.

Returns: the path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 289 of file AttachEntities.java.

                                      {
     return null;
   }

◆ getFile()

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

Gets the file represented by the entity.

Returns: the entity file.

Implements org.turro.entities.IElephantEntity.

Definition at line 190 of file AttachEntities.java.

                         {
     if(getEntity() != null) {
       if(entity instanceof Attachment) {
         try {
           File file = File.createTempFile("attach_", "_mail");
           AttachWd.writeToFile((Attachment) getEntity(), file);
           return file;
         } catch (IOException ex) {
           Logger.getLogger(AttachEntities.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(null), ex);
         }
       } else if(entity instanceof File) {
         return (File) entity;
       }
     }
     return null;
   }

Here is the call graph for this function:

◆ getHierarchicalPath()

String org.turro.entities.AttachEntities.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 158 of file AttachEntities.java.

                                       {
     if(getEntity() != null) {
       if(entity instanceof Attachment) {
         IElephantEntity iee = ((Attachment) entity).getOwnerEntity();
         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.AttachEntities.getImage ( )

Gets the entity image based on its root.

Returns: the string image location.

Implements org.turro.entities.IElephantEntity.

Definition at line 127 of file AttachEntities.java.

                            {
     if(getPath() != null) {
       String root = path.getRoot();
       if(null != root) switch (root) {
         case "attachment":
           return "/_zul/images/clip.png";
         case "file":
           return "/_zul/images/clip.png";
         default:
           break;
       }
     }
     return null;
   }

Here is the call graph for this function:

◆ getLabel()

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

Gets the entity label, based on its root.

Returns: the entity string label.

Implements org.turro.entities.IElephantEntity.

Definition at line 101 of file AttachEntities.java.

                            {
     if(getPath() != null) {
       String root = path.getRoot();
       if(null != root) switch (root) {
         case "attachment":
           return I_.get("Attachment");
         case "file":
           return I_.get("File");
         default:
           break;
       }
     }
     return null;
   }

Here is the call graph for this function:

◆ getLabelCtrl()

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

Gets the label control, usually a clickable LabelControl class.

Returns: a clickable label control.

Implements org.turro.entities.IElephantEntity.

Definition at line 122 of file AttachEntities.java.

                                {
     return null;
   }

◆ getMimeImage()

String org.turro.entities.AttachEntities.getMimeImage ( )

Definition at line 142 of file AttachEntities.java.

                                {
     if(getPath() != null) {
       String root = path.getRoot();
       if(null != root) switch (root) {
         case "attachment":
           return getMimeImage(entity);
         case "file":
           return getMimeImage(entity);
         default:
           break;
       }
     }
     return null;
   }

Here is the call graph for this function:

◆ getName()

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

Gets the entity name.

Returns: the string name.

Implements org.turro.entities.IElephantEntity.

Definition at line 89 of file AttachEntities.java.

                           {
     if(getEntity() != null) {
       if(entity instanceof Attachment) {
         return ((Attachment) entity).getFileName();
       } else if(entity instanceof File) {
         return ((File) entity).getName();
       }
     }
     return null;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParent()

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

Gets the parent for this entity.

Returns: the parent controller.

Implements org.turro.entities.IElephantEntity.

Definition at line 170 of file AttachEntities.java.

                                      {
     if(getEntity() != null) {
       if(entity instanceof Attachment) {
         return ((Attachment) entity).getOwnerEntity();
       }
     }
     return null;
   }

Here is the call graph for this function:

◆ getUserContext()

String org.turro.entities.AttachEntities.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 AttachEntities.java.

                                  {
     return null;
   }

◆ itsMine() [1/2]

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

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 309 of file AttachEntities.java.

                                            {
     return (entity instanceof Attachment) || (entity instanceof File);
   }

◆ itsMine() [2/2]

boolean org.turro.entities.AttachEntities.itsMine ( String rootPath )

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 304 of file AttachEntities.java.

                                              {
     return super.itsMine(rootPath) || "file".equals(rootPath);
   }

◆ showEntity()

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

Shows the view for the entity.

Returns: true when a view is shown.

Implements org.turro.entities.IElephantEntity.

Definition at line 213 of file AttachEntities.java.

                               {
     if(getEntity() != null) {
       if(entity instanceof Attachment) {
         AttachmentUtil.download((Attachment) entity);
         return true;
       } else if(entity instanceof File) {
         new FileWrapper((File) entity).download();
         return true;
       }
     }
     return false;
   }

Here is the call graph for this function:

◆ showPath()

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

Shows the view for this path.

Returns: true when a view is shown.

Implements org.turro.entities.IElephantEntity.

Definition at line 208 of file AttachEntities.java.

                             {
     return false;
   }

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

AttachEntities.java

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AttachEntities() [1/3]

◆ AttachEntities() [2/3]

◆ AttachEntities() [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()

◆ getExtendedPath()

◆ getExtendedWebPath()

◆ getFile()

◆ getHierarchicalPath()

◆ getImage()

◆ getLabel()

◆ getLabelCtrl()

◆ getMimeImage()

◆ getName()

◆ getParent()

◆ getUserContext()

◆ itsMine() [1/2]

◆ itsMine() [2/2]

◆ showEntity()

◆ showPath()