org.turro.elephant.web.ElContext Class Reference

Inheritance diagram for org.turro.elephant.web.ElContext:

Collaboration diagram for org.turro.elephant.web.ElContext:

Public Member Functions
	ElContext ()
String	getId ()
String	getName ()
String	getFullPath ()
String	getWebPath ()
String	getPath ()
boolean	inPath (ElContext context)
int	getLevel ()
File	getFile ()
String	getVerbosePath ()
String	getVerbosePath (ElContext root)
String	getTarget ()
boolean	isPublic ()
boolean	canShowTo (IContact contact)
boolean	canDisplay ()
boolean	hasRestrictions ()
boolean	isSelectable ()
boolean	isInRole ()
boolean	canPrint ()
ElContext	getParent ()
boolean	isIndexable ()
boolean	isFollowable ()
TreeSet< ElContext >	getChildren ()
TreeSet< ElContext >	getStaticChildren ()
TreeSet< ElContext >	getVisibleChildren ()
TreeSet< ElContext >	getSiblings ()
TreeSet< ElContext >	getVisibleSiblings ()
TreeSet< ElContext >	getAncestors ()
ElContext	getPrevious ()
ElContext	getNext (boolean doChildren)
IContext	getContext ()
String	getRepositoryPath ()
Repository	getRepository ()
WebResources	getResources ()
Set< String >	getDefaultLocales ()
WebContext	getWebContext ()
void	construct (IConstructor constructor) throws ServletException, IOException
void	setTitle (String title)
String	getTitle ()
IElement	getElement ()
void	generateCategoriesChildren (Tree tree, Function< Item, String > onParam)
SocialImage	getSocialImage ()
String	getTemplateRoot ()
String	getTemplate ()
FoundList	search (String value, boolean ignoreCase)
void	resetDefaultLocales ()
int	compareTo (ElContext o)
int	hashCode ()
boolean	equals (Object obj)

Static Public Member Functions
static boolean	isInternal (File file)
static String	extractPath (String path)

Static Public Attributes
static final String	CONTEXT_FOLDER = "/_internal"

Protected Member Functions
	ElContext (String path, File folder, ElContext parent)
	ElContext (String path, String params, File folder, ElContext parent)
final void	init ()

Protected Attributes
File	folder
String	title
int	level
Set< String >	defaultLocales
ElContext	parent
TreeSet< ElContext >	children
WebContext	webContext

Detailed Description

Author

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

Definition at line 61 of file ElContext.java.

Constructor & Destructor Documentation

ElContext() [1/3]

org.turro.elephant.web.ElContext.ElContext

(

)

Definition at line 77 of file ElContext.java.

                     {
    this("", null, new File(ElephantContext.getRealPath("/")), null);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

ElContext() [2/3]

org.turro.elephant.web.ElContext.ElContext ( String  path, File  folder, ElContext  parent  )

protected

Definition at line 81 of file ElContext.java.

                                                                  {
    this(path, null, folder, parent);
  }

ElContext() [3/3]

org.turro.elephant.web.ElContext.ElContext ( String  path, String  params, File  folder, ElContext  parent  )

protected

Definition at line 85 of file ElContext.java.

                                                                                 {
    this.path = path;
    this.params = params;
    this.folder = folder;
    this.parent = parent;
    init();
  }

Here is the call graph for this function:

Member Function Documentation

canDisplay()

boolean org.turro.elephant.web.ElContext.canDisplay

(

)

Definition at line 161 of file ElContext.java.

                              {
    return isSelectable() && (webContext.isShowAlways() || isInRole());
  }

Here is the call graph for this function:

canPrint()

boolean org.turro.elephant.web.ElContext.canPrint

(

)

Definition at line 179 of file ElContext.java.

                            {
    return (webContext.isPrintContext() && isInRole());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

canShowTo()

boolean org.turro.elephant.web.ElContext.canShowTo

(

IContact

contact

)

Definition at line 156 of file ElContext.java.

                                             {
    if(isPublic()) return true;
    return contact.getPermissions().isInRole(webContext.getRole());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

compareTo()

int org.turro.elephant.web.ElContext.compareTo

(

ElContext

o

)

Definition at line 593 of file ElContext.java.

                                    {
    int result = 0;
    result = CompareUtil.compare(level, o.level);
    if(result == 0) {
      result = CompareUtil.compare(webContext.getOrder(), o.webContext.getOrder());
    }
    if(result == 0) {
      result = CompareUtil.compare(getName(), o.getName());
    }
    if(result == 0) {
      result = CompareUtil.compare(getId(), o.getId());
    }
    if(result == 0) {
      result = CompareUtil.compare(path, o.path);
    }
    return result;
  }

Here is the call graph for this function:

construct()

void org.turro.elephant.web.ElContext.construct

(

IConstructor

constructor

)

throws ServletException, IOException

Definition at line 355 of file ElContext.java.

                                                                                       {
    new ContextConstructor(constructor, this).start();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

equals()

boolean org.turro.elephant.web.ElContext.equals

(

Object

obj

)

Definition at line 621 of file ElContext.java.

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

Here is the call graph for this function:

Here is the caller graph for this function:

extractPath()

static String org.turro.elephant.web.ElContext.extractPath ( String  path )

static

Definition at line 574 of file ElContext.java.

                                                {
    if(path == null) {
      path = "/";
    } else {
      int p = path.indexOf("?");
      if(p > -1) {
        path = path.substring(0, p);
      }
    }
    return path;
  }

Here is the caller graph for this function:

generateCategoriesChildren()

void org.turro.elephant.web.ElContext.generateCategoriesChildren	(	Tree	tree,
		Function< Item, String >	onParam
	)

Definition at line 491 of file ElContext.java.

                                                                                    {
    for(Item item : (List<Item>) tree.getItems()) {
      addCategoriesChildren(getPath(), item, onParam);
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getAncestors()

TreeSet<ElContext> org.turro.elephant.web.ElContext.getAncestors

(

)

Definition at line 235 of file ElContext.java.

                                           {
    TreeSet<ElContext> ancestors = new TreeSet<>();
    ElContext ctx = this;
    while(ctx != null) {
      ancestors.add(ctx);
      ctx = ctx.parent;
    }
    return ancestors;
  }

Here is the caller graph for this function:

getChildren()

TreeSet<ElContext> org.turro.elephant.web.ElContext.getChildren

(

)

Definition at line 196 of file ElContext.java.

                                          {
    generateDynamic();
    return children;
  }

Here is the caller graph for this function:

getContext()

IContext org.turro.elephant.web.ElContext.getContext

(

)

Definition at line 280 of file ElContext.java.

                               {
    return ContextFactory.getContext(Application.getApplication().getConstructor(), path);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultLocales()

Set<String> org.turro.elephant.web.ElContext.getDefaultLocales

(

)

Definition at line 318 of file ElContext.java.

                                         {
    if(defaultLocales == null) {
      ElContext ctx = this;
      while(ctx != null && ctx.webContext.getLangs().isEmpty()) {
        ctx = ctx.parent;
      }
      defaultLocales = ctx.webContext.getLangs();
    }
    return defaultLocales;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getElement()

IElement org.turro.elephant.web.ElContext.getElement

(

)

Definition at line 447 of file ElContext.java.

                               {
    IElement iel = webContext.getElementInstance();
    iel.setConfiguration(Application.getApplication().getConstructor(), this);
    return iel;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getFile()

File org.turro.elephant.web.ElContext.getFile

(

)

Definition at line 130 of file ElContext.java.

                        {
    return folder;
  }

Here is the caller graph for this function:

getFullPath()

String org.turro.elephant.web.ElContext.getFullPath

(

)

Definition at line 101 of file ElContext.java.

                              {
    String tmp = ElephantContext.getRootWebPath() + path;
    return (Strings.isBlank(tmp) ? "/" : tmp + (Strings.isBlank(params) ? "" : params));
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getId()

String org.turro.elephant.web.ElContext.getId

(

)

Definition at line 93 of file ElContext.java.

                        {
    return folder.getName();
  }

Here is the caller graph for this function:

getLevel()

int org.turro.elephant.web.ElContext.getLevel

(

)

Definition at line 126 of file ElContext.java.

                        {
    return path == null ? 0 : path.split("\\/").length - 1;
  }

Here is the caller graph for this function:

getName()

String org.turro.elephant.web.ElContext.getName

(

)

Definition at line 97 of file ElContext.java.

                          {
    return Optional.ofNullable(webContext.getName()).orElse(getId());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getNext()

ElContext org.turro.elephant.web.ElContext.getNext

(

boolean

doChildren

)

Definition at line 265 of file ElContext.java.

                                               {
    if(doChildren) {
      TreeSet<ElContext> set = getVisibleChildren();
      if(!set.isEmpty()) return set.first();
    }
    if(getParent() != null) {
      boolean found = false;
      for (ElContext sibling : getVisibleSiblings()) {
        if(found && sibling.canDisplay()) return sibling;
        if(sibling.equals(this)) found = true;
      }
    }
    return parent.getNext(false);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getParent()

ElContext org.turro.elephant.web.ElContext.getParent

(

)

Definition at line 183 of file ElContext.java.

                               {
    return parent;
  }

Here is the caller graph for this function:

getPath()

String org.turro.elephant.web.ElContext.getPath

(

)

Definition at line 118 of file ElContext.java.

                          {
    return path;
  }

Here is the caller graph for this function:

getPrevious()

ElContext org.turro.elephant.web.ElContext.getPrevious

(

)

Definition at line 245 of file ElContext.java.

                                 {
    if(getParent() != null) {
      boolean found = false;
      for (ElContext sibling : getVisibleSiblings().descendingSet()) {
        if(found && sibling.canDisplay()) return getLastChildren(sibling);
        if(sibling.equals(this)) found = true;
      }
      return getParent();
    }
    return null;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getRepository()

Repository org.turro.elephant.web.ElContext.getRepository

(

)

Definition at line 288 of file ElContext.java.

                                    {
    return new Repository(Application.getApplication().getConstructor(), WebContext.repository(Path.of(path)).toString());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getRepositoryPath()

String org.turro.elephant.web.ElContext.getRepositoryPath

(

)

Definition at line 284 of file ElContext.java.

                                    {
    return WebContext.repository(Path.of(path)).toString();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getResources()

WebResources org.turro.elephant.web.ElContext.getResources

(

)

Definition at line 292 of file ElContext.java.

                                     {
    return folder != null ? new WebResources(folder.toPath()) : null;
  }

Here is the caller graph for this function:

getSiblings()

TreeSet<ElContext> org.turro.elephant.web.ElContext.getSiblings

(

)

Definition at line 217 of file ElContext.java.

                                          {
    if(parent == null) {
      TreeSet<ElContext> set = new TreeSet<>();
      set.add(this);
      return set;
    } else {
      return parent.getChildren();
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getSocialImage()

SocialImage org.turro.elephant.web.ElContext.getSocialImage

(

)

Definition at line 519 of file ElContext.java.

                                      {
    return SocialImageMap.getImage(getFullPath());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getStaticChildren()

TreeSet<ElContext> org.turro.elephant.web.ElContext.getStaticChildren

(

)

Definition at line 201 of file ElContext.java.

                                                {
    TreeSet<ElContext> statics = new TreeSet<>();
    for(ElContext ctx : children) {
      if(!ctx.getWebContext().isDynamic()) statics.add(ctx);
    }
    return statics;
  }

Here is the caller graph for this function:

getTarget()

String org.turro.elephant.web.ElContext.getTarget

(

)

Definition at line 148 of file ElContext.java.

                            {
    return webContext.getTarget();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplate()

String org.turro.elephant.web.ElContext.getTemplate

(

)

Definition at line 537 of file ElContext.java.

                              {
    if(!Strings.isBlank(webContext.getLayout().getLocal())) {
      return webContext.getLayout().getLocal();      
    }
    return findTemplate(this);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getTemplateRoot()

String org.turro.elephant.web.ElContext.getTemplateRoot

(

)

Definition at line 525 of file ElContext.java.

                                  {
    return findRoot(this);
  }

Here is the caller graph for this function:

getTitle()

String org.turro.elephant.web.ElContext.getTitle

(

)

Definition at line 363 of file ElContext.java.

                           {
    return Strings.isBlank(title) ? getName() : title;
  }

Here is the call graph for this function:

getVerbosePath() [1/2]

String org.turro.elephant.web.ElContext.getVerbosePath

(

)

Definition at line 134 of file ElContext.java.

                                 {
    return getVerbosePath(null);
  }

getVerbosePath() [2/2]

String org.turro.elephant.web.ElContext.getVerbosePath

(

ElContext

root

)

Definition at line 138 of file ElContext.java.

                                               {
    String result = getName();
    ElContext ctx = parent;
    while(ctx != null && !ctx.equals(root)) {
      result = ctx.getName() + " " + result;
      ctx = ctx.parent;
    }
    return result;
  }

Here is the call graph for this function:

getVisibleChildren()

TreeSet<ElContext> org.turro.elephant.web.ElContext.getVisibleChildren

(

)

Definition at line 209 of file ElContext.java.

                                                 {
    TreeSet<ElContext> visible = new TreeSet<>();
    for(ElContext ctx : children) {
      if(ctx.canDisplay()) visible.add(ctx);
    }
    return visible;
  }

Here is the caller graph for this function:

getVisibleSiblings()

TreeSet<ElContext> org.turro.elephant.web.ElContext.getVisibleSiblings

(

)

Definition at line 227 of file ElContext.java.

                                                 {
    TreeSet<ElContext> visible = new TreeSet<>();
    for(ElContext ctx : getSiblings()) {
      if(ctx.canDisplay()) visible.add(ctx);
    }
    return visible;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getWebContext()

WebContext org.turro.elephant.web.ElContext.getWebContext

(

)

Definition at line 329 of file ElContext.java.

                                    {
    return webContext;
  }

Here is the caller graph for this function:

getWebPath()

String org.turro.elephant.web.ElContext.getWebPath

(

)

Definition at line 106 of file ElContext.java.

                             {
    if(Strings.isBlank(webContext.getRedirect())) {
      return getFullPath();
    } else if(webContext.getRedirect().startsWith("/")) {
      return ElephantContext.getRootWebPath() + webContext.getRedirect();
    } else if(webContext.getRedirect().contains("://")) {
      return webContext.getRedirect();
    } else {
      return getFullPath() + "/" + webContext.getRedirect();
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

hashCode()

int org.turro.elephant.web.ElContext.hashCode

(

)

Definition at line 614 of file ElContext.java.

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

hasRestrictions()

boolean org.turro.elephant.web.ElContext.hasRestrictions

(

)

Definition at line 165 of file ElContext.java.

                                   {
    return !(webContext.isShowInNavigators() && (webContext.isShowAlways() || Strings.isEmpty(webContext.getRole())));
  }

Here is the call graph for this function:

init()

final void org.turro.elephant.web.ElContext.init ( )

protected

Definition at line 296 of file ElContext.java.

                              {
    readConfiguration();
    level = path == null ? 0 : path.split("\\/").length - 1;
    ElContextMap.addContext(this);
    if(children == null) {
      children = new TreeSet<>();
      if(folder.isDirectory()) {
        File[] subfolders = folder.listFiles();
        for(File subfolder: subfolders) {
          if(subfolder.isDirectory() && !subfolder.isHidden()) {
            if(!isInternal(subfolder)) {
              if(Files.exists(path + "/" + subfolder.getName() + CONTEXT_FILE) ||
                 WebContext.existsConf(Path.of(path))) {
                children.add(new ElContext(path + "/" + subfolder.getName(), subfolder, this));
              }
            }
          }
        }
      }
    }
  }

Here is the call graph for this function:

Here is the caller graph for this function:

inPath()

boolean org.turro.elephant.web.ElContext.inPath

(

ElContext

context

)

Definition at line 122 of file ElContext.java.

                                           {
    return context.getFullPath().matches(getFullPath() + "(\\/.*)?");
  }

Here is the call graph for this function:

Here is the caller graph for this function:

isFollowable()

boolean org.turro.elephant.web.ElContext.isFollowable

(

)

Definition at line 192 of file ElContext.java.

                                {
    return !webContext.isNoFollow();
  }

Here is the call graph for this function:

isIndexable()

boolean org.turro.elephant.web.ElContext.isIndexable

(

)

Definition at line 187 of file ElContext.java.

                               {
    return !webContext.isNoIndex() && Strings.isBlank(webContext.getRedirect()) &&
            !getPath().startsWith("/user");
  }

Here is the call graph for this function:

isInRole()

boolean org.turro.elephant.web.ElContext.isInRole

(

)

Definition at line 173 of file ElContext.java.

                            {
    if(parent != null && !parent.isInRole()) return false;
    if(Strings.isBlank(webContext.getRole())) return true;
    return UserMenus.isInRole(path) && Application.getApplication().isInRole(webContext.getRole());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

isInternal()

static boolean org.turro.elephant.web.ElContext.isInternal ( File  file )

static

Definition at line 333 of file ElContext.java.

                                              {
    if(file == null) return true;
    String fileName = file.isFile() ? file.getName() : file.getAbsolutePath();
    String internals = ElephantContext.getSiteInternalFiles();
    if(internals != null) {
      String tmp[] = internals.split(",");
      for(String s : tmp) {
        if(fileName.matches(Strings.convertToRegEx(s))) return true;
      }
    }
    return (fileName.matches("google.*\\.html")) ||
            (fileName.matches("site.*\\.xml")) ||
            (fileName.matches("robots\\.txt")) ||
            (fileName.contains("_internal")) ||
            (fileName.contains("_zul")) ||
            (fileName.contains("resources")) ||
            (fileName.contains("WEB-INF")) ||
            (fileName.contains("META-INF"));
  }

Here is the call graph for this function:

Here is the caller graph for this function:

isPublic()

boolean org.turro.elephant.web.ElContext.isPublic

(

)

Definition at line 152 of file ElContext.java.

                            {
    return Strings.isBlank(webContext.getRole());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

isSelectable()

boolean org.turro.elephant.web.ElContext.isSelectable

(

)

Definition at line 169 of file ElContext.java.

                                {
    return webContext.isShowInNavigators();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

resetDefaultLocales()

void org.turro.elephant.web.ElContext.resetDefaultLocales

(

)

Definition at line 586 of file ElContext.java.

                                    {
    defaultLocales = null;
  }

Here is the caller graph for this function:

search()

FoundList org.turro.elephant.web.ElContext.search	(	String	value,
		boolean	ignoreCase
	)

Definition at line 554 of file ElContext.java.

                                                            {
    FoundList fl = new FoundList();
    SearchFormatter sf = new SearchFormatter(value, ignoreCase);
    sf.processLine(getName());
    if(sf.wasFound()) {
      fl.addItem(
              getId() == null ? "" : getId(),
              (getPath().length() == 0 ? "/" : getPath()),
              "<img src='" + ElephantContext.getRootResourcePath() + "/_internal/system/images/context.gif'/>",
              getName(),
              sf.getResult(),
              (double)sf.getFound(),
              value
              );
    }
    return fl;
  }

Here is the call graph for this function:

setTitle()

void org.turro.elephant.web.ElContext.setTitle

(

String

title

)

Definition at line 359 of file ElContext.java.

                                     {
    this.title = title;
  }

Here is the caller graph for this function:

Member Data Documentation

children

TreeSet<ElContext> org.turro.elephant.web.ElContext.children

protected

Definition at line 73 of file ElContext.java.

CONTEXT_FOLDER

final String org.turro.elephant.web.ElContext.CONTEXT_FOLDER = "/_internal"

static

Definition at line 64 of file ElContext.java.

defaultLocales

Set<String> org.turro.elephant.web.ElContext.defaultLocales

protected

Definition at line 71 of file ElContext.java.

folder

File org.turro.elephant.web.ElContext.folder

protected

Definition at line 68 of file ElContext.java.

level

int org.turro.elephant.web.ElContext.level

protected

Definition at line 70 of file ElContext.java.

parent

ElContext org.turro.elephant.web.ElContext.parent

protected

Definition at line 72 of file ElContext.java.

title

String org.turro.elephant.web.ElContext.title

protected

Definition at line 69 of file ElContext.java.

webContext

WebContext org.turro.elephant.web.ElContext.webContext

protected

Definition at line 75 of file ElContext.java.

---

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

• ElContext.java