Inheritance diagram for org.turro.documentation.DocumentDefinition:

Collaboration diagram for org.turro.documentation.DocumentDefinition:

Public Member Functions
	DocumentDefinition (String name, DocumentType type)

DocumentDefinition	allowedRoot (String root)

DocumentDefinition	description (String text)

DocumentDefinition	allowMultiple ()

DocumentDefinition	uploadControl ()

DocumentDefinition	min (int min)

DocumentDefinition	max (int max)

String	getName ()

DocumentType	getType ()

void	setAllowedRoot (String allowedRoot)

String	getAllowedRoot ()

void	setDescription (String description)

String	getDescription ()

boolean	isAllowMultiple ()

void	setAllowMultiple (boolean allowMultiple)

boolean	isUploadControl ()

void	setUploadControl (boolean uploadControl)

void	setMin (int min)

int	getMin ()

void	setMax (int max)

int	getMax ()

boolean	isInformation ()

boolean	isFiltered ()

boolean	matches (String root)

Map< String, List< Document > >	getDocumentsMap ()

List< Document >	getDocumentsFor (IContact contact)

Folder	getFolder ()

String	getFolderString ()

String	getFolderName ()

boolean	canDelete ()

int	hashCode ()

boolean	equals (Object obj)

int	compareTo (DocumentDefinition o)

Public Attributes
final String	name

final DocumentType	type

String	description

boolean	allowMultiple

int	min

Detailed Description

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

Definition at line 42 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

Constructor & Destructor Documentation

◆ DocumentDefinition()

org.turro.documentation.DocumentDefinition.DocumentDefinition	(	String	name,
		DocumentType	type
	)

Definition at line 50 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                                             {
     this.name = name;
     this.type = type;
     this.min = 1;
     this.max = 1;
   }

Here is the caller graph for this function:

Member Function Documentation

◆ allowedRoot()

DocumentDefinition org.turro.documentation.DocumentDefinition.allowedRoot ( String root )

Definition at line 57 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                                      {
     this.allowedRoot = root;
     return this;
   }

◆ allowMultiple()

DocumentDefinition org.turro.documentation.DocumentDefinition.allowMultiple ( )

Definition at line 67 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                             {
     this.allowMultiple = true;
     return this;
   }

◆ canDelete()

boolean org.turro.documentation.DocumentDefinition.canDelete ( )

Definition at line 201 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                              {
     return SqlClause.select("count(ed)")
             .from("EntityDocumentation ed")
             .where().equal("ed.documentation", name)
             .dao(new AttachPU())
             .singleResult(Long.class) == 0L;
   }

Here is the caller graph for this function:

◆ compareTo()

int org.turro.documentation.DocumentDefinition.compareTo ( DocumentDefinition o )

Definition at line 232 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                              {
     return CompareUtil.compare(name, o.name);
   }

◆ description()

DocumentDefinition org.turro.documentation.DocumentDefinition.description ( String text )

Definition at line 62 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                                      {
     this.description = text;
     return this;
   }

◆ equals()

boolean org.turro.documentation.DocumentDefinition.equals ( Object obj )

Definition at line 217 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                     {
     if (this == obj) {
       return true;
     }
     if (obj == null) {
       return false;
     }
     if (getClass() != obj.getClass()) {
       return false;
     }
     final DocumentDefinition other = (DocumentDefinition) obj;
     return Objects.equals(this.name, other.name);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllowedRoot()

String org.turro.documentation.DocumentDefinition.getAllowedRoot ( )

Definition at line 99 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                  {
     return allowedRoot;
   }

◆ getDescription()

String org.turro.documentation.DocumentDefinition.getDescription ( )

Definition at line 107 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                  {
     return description;
   }

◆ getDocumentsFor()

List<Document> org.turro.documentation.DocumentDefinition.getDocumentsFor ( IContact contact )

Definition at line 171 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                                           {
     List<Document> docs = new ArrayList<>();
     Folder folder = getFolder();
     try {
       if(folder.exists()) docs.addAll(folder.documents());
       Folder selfDocs = folder.child(contact.getId());
       if(selfDocs.exists()) docs.addAll(selfDocs.documents());
       IContact parent = contact.getBusiness();
       if(parent != null) {
         Folder parentDocs = folder.child(parent.getId());
         if(parentDocs.exists()) docs.addAll(parentDocs.documents());
       }
     } catch (IOException ex) {
       Logger.getLogger(DocumentDefinition.class.getName()).log(Level.SEVERE, null, ex);
     }
     return docs;
   }

Here is the call graph for this function:

◆ getDocumentsMap()

Map<String, List<Document> > org.turro.documentation.DocumentDefinition.getDocumentsMap ( )

Definition at line 157 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                                        {
     Map<String, List<Document>> docs = new TreeMap<>();
     Folder folder = getFolder();
     try {
       if(folder.exists()) docs.put("*", folder.documents());
       for(Folder child : folder.folders()) {
         docs.put(child.name(), child.documents());
       }
     } catch (IOException ex) {
       Logger.getLogger(DocumentDefinition.class.getName()).log(Level.SEVERE, null, ex);
     }
     return docs;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFolder()

Folder org.turro.documentation.DocumentDefinition.getFolder ( )

Definition at line 189 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                             {
     return Folder.from(ElephantContext.getRealPath(getFolderString()));
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFolderName()

String org.turro.documentation.DocumentDefinition.getFolderName ( )

Definition at line 197 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                 {
     return "hash-" + hashCode() + "-def";
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFolderString()

String org.turro.documentation.DocumentDefinition.getFolderString ( )

Definition at line 193 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                   {
     return "/WEB-INF/files/doc-references/" + getFolderName();
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMax()

int org.turro.documentation.DocumentDefinition.getMax ( )

Definition at line 139 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                       {
     return max;
   }

Here is the caller graph for this function:

◆ getMin()

int org.turro.documentation.DocumentDefinition.getMin ( )

Definition at line 131 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                       {
     return min;
   }

Here is the caller graph for this function:

◆ getName()

String org.turro.documentation.DocumentDefinition.getName ( )

Definition at line 87 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                           {
     return name;
   }

Here is the caller graph for this function:

◆ getType()

DocumentType org.turro.documentation.DocumentDefinition.getType ( )

Definition at line 91 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                 {
     return type;
   }

◆ hashCode()

int org.turro.documentation.DocumentDefinition.hashCode ( )

Definition at line 210 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                         {
     int hash = 7;
     hash = 73 * hash + Objects.hashCode(this.name);
     return hash;
   }

Here is the caller graph for this function:

◆ isAllowMultiple()

boolean org.turro.documentation.DocumentDefinition.isAllowMultiple ( )

Definition at line 111 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                    {
     return allowMultiple;
   }

Here is the caller graph for this function:

◆ isFiltered()

boolean org.turro.documentation.DocumentDefinition.isFiltered ( )

Definition at line 149 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                               {
     return !"*".equals(Strings.isBlank(allowedRoot, "*"));
   }

Here is the caller graph for this function:

◆ isInformation()

boolean org.turro.documentation.DocumentDefinition.isInformation ( )

Definition at line 145 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                  {
     return !Strings.isBlank(description) || !getFolder().isEmpty();
   }

Here is the call graph for this function:

◆ isUploadControl()

boolean org.turro.documentation.DocumentDefinition.isUploadControl ( )

Definition at line 119 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                    {
     return uploadControl;
   }

Here is the caller graph for this function:

◆ matches()

boolean org.turro.documentation.DocumentDefinition.matches ( String root )

Definition at line 153 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                       {
     return !isFiltered() || (CompareUtil.compare(root, allowedRoot) == 0);
   }

Here is the call graph for this function:

◆ max()

DocumentDefinition org.turro.documentation.DocumentDefinition.max ( int max )

Definition at line 82 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                          {
     this.max = max;
     return this;
   }

◆ min()

DocumentDefinition org.turro.documentation.DocumentDefinition.min ( int min )

Definition at line 77 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                          {
     this.min = min;
     return this;
   }

◆ setAllowedRoot()

void org.turro.documentation.DocumentDefinition.setAllowedRoot ( String allowedRoot )

Definition at line 95 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                                  {
     this.allowedRoot = allowedRoot;
   }

◆ setAllowMultiple()

void org.turro.documentation.DocumentDefinition.setAllowMultiple ( boolean allowMultiple )

Definition at line 115 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                                       {
     this.allowMultiple = allowMultiple;
   }

◆ setDescription()

void org.turro.documentation.DocumentDefinition.setDescription ( String description )

Definition at line 103 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                                  {
     this.description = description;
   }

◆ setMax()

void org.turro.documentation.DocumentDefinition.setMax ( int max )

Definition at line 135 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                               {
     this.max = max;
   }

◆ setMin()

void org.turro.documentation.DocumentDefinition.setMin ( int min )

Definition at line 127 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                               {
     this.min = min;
   }

◆ setUploadControl()

void org.turro.documentation.DocumentDefinition.setUploadControl ( boolean uploadControl )

Definition at line 123 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                                       {
     this.uploadControl = uploadControl;
   }

◆ uploadControl()

DocumentDefinition org.turro.documentation.DocumentDefinition.uploadControl ( )

Definition at line 72 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

                                             {
     this.uploadControl = true;
     return this;
   }

Member Data Documentation

◆ allowMultiple

boolean org.turro.documentation.DocumentDefinition.allowMultiple

Definition at line 47 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

◆ description

String org.turro.documentation.DocumentDefinition.description

Definition at line 46 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

◆ min

int org.turro.documentation.DocumentDefinition.min

Definition at line 48 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

◆ name

final String org.turro.documentation.DocumentDefinition.name

Definition at line 44 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

◆ type

final DocumentType org.turro.documentation.DocumentDefinition.type

Definition at line 45 of file elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java.

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

elephant-attach/src/main/java/org/turro/documentation/DocumentDefinition.java

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DocumentDefinition()

Member Function Documentation

◆ allowedRoot()

◆ allowMultiple()

◆ canDelete()

◆ compareTo()

◆ description()

◆ equals()

◆ getAllowedRoot()

◆ getDescription()

◆ getDocumentsFor()

◆ getDocumentsMap()

◆ getFolder()

◆ getFolderName()

◆ getFolderString()

◆ getMax()

◆ getMin()

◆ getName()

◆ getType()

◆ hashCode()

◆ isAllowMultiple()

◆ isFiltered()

◆ isInformation()

◆ isUploadControl()

◆ matches()

◆ max()

◆ min()

◆ setAllowedRoot()

◆ setAllowMultiple()

◆ setDescription()

◆ setMax()

◆ setMin()

◆ setUploadControl()

◆ uploadControl()

Member Data Documentation

◆ allowMultiple

◆ description

◆ min

◆ name

◆ type