Inheritance diagram for org.turro.indicator.AbstractIndicator:

[legend]

Collaboration diagram for org.turro.indicator.AbstractIndicator:

Public Member Functions
void	initIndicator ()

void	prepareIndicator ()

void	generateSiblings ()

String	getRoot ()

List< IndicatorVariable >	getVariables ()

List< IndicatorVariable >	getAllVariables ()

IndicatorVariable	getVariable (String name)

List< IndicatorVariable >	getAllRankingVariables (String root)

List< IndicatorVariable >	getAllMatchingVariables (String root)

double	getValue (IndicatorVariable variable, Object entity)

double	getValue (IndicatorVariable variable, Object entity, String relatedPath)

IndicatorResult	readIndicator (String storeClass, String indicator)

void	preprocess (IndicatorVariable variable, IPreprocessor preprocessor, String entityRoot, String relatedRoot)

void	postprocess (IndicatorVariable variable, IPreprocessor postprocessor, String entityRoot, String relatedRoot)

Stream< String >	getEntityPaths (String root)

Stream< GenericSiblings >	getSiblingPaths (String entityPath)

Dao	getDao ()

boolean	itsMine (String root)

boolean	itsMine (IndicatorVariable variable)

Protected Member Functions
void	addVariable (String name, VariableType type)

void	addVariable (String name, VariableType type, boolean reversed)

void	addVariable (String name, VariableType type, String avoid)

void	addVariable (String name, boolean preprocess, VariableType type)

void	addVariable (String name, boolean preprocess, VariableType type, boolean reversed)

void	addVariable (String name, boolean preprocess, VariableType type, String avoid)

void	addExternalVariable (String root, String name)

String	getPath (Object entity)

abstract void	initVariables ()

abstract void	initExternalVariables ()

abstract void	processRankingVariable (Dao dao, IPreprocessor preprocessor, IndicatorVariable variable, String entityRoot)

abstract void	processMatchingVariable (Dao dao, IPreprocessor preprocessor, IndicatorVariable variable, String entityRoot, String relatedRoot)

void	postprocessRankingVariable (Dao dao, IPreprocessor postprocessor, IndicatorVariable variable, String entityRoot)

void	postprocessMatchingVariable (Dao dao, IPreprocessor postprocessor, IndicatorVariable variable, String entityRoot, String relatedRoot)

abstract Dao	createDao ()

Protected Attributes
List< IndicatorVariable >	variables = new ArrayList<>()

String	root

Detailed Description

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

Definition at line 37 of file AbstractIndicator.java.

Member Function Documentation

◆ addExternalVariable()

void org.turro.indicator.AbstractIndicator.addExternalVariable	(	String	root,
		String	name
	)

protected

Definition at line 86 of file AbstractIndicator.java.

                                                                {
     IndicatorVariable variable = Indicators.getVariable(root, name);
     if(variable != null) variables.add(variable);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addVariable() [1/6]

void org.turro.indicator.AbstractIndicator.addVariable	(	String	name,
		boolean	preprocess,
		VariableType	type
	)

protected

Definition at line 74 of file AbstractIndicator.java.

                                                                                  {
     variables.add(new IndicatorVariable(root, name, preprocess, type));
   }

Here is the call graph for this function:

◆ addVariable() [2/6]

void org.turro.indicator.AbstractIndicator.addVariable	(	String	name,
		boolean	preprocess,
		VariableType	type,
		boolean	reversed
	)

protected

Definition at line 78 of file AbstractIndicator.java.

                                                                                                    {
     variables.add(new IndicatorVariable(root, name, preprocess, type, reversed));
   }

Here is the call graph for this function:

◆ addVariable() [3/6]

void org.turro.indicator.AbstractIndicator.addVariable	(	String	name,
		boolean	preprocess,
		VariableType	type,
		String	avoid
	)

protected

Definition at line 82 of file AbstractIndicator.java.

                                                                                                {
     variables.add(new IndicatorVariable(root, name, preprocess, type, avoid));
   }

Here is the call graph for this function:

◆ addVariable() [4/6]

void org.turro.indicator.AbstractIndicator.addVariable	(	String	name,
		VariableType	type
	)

protected

Definition at line 62 of file AbstractIndicator.java.

                                                              {
     variables.add(new IndicatorVariable(root, name, false, type));
   }

Here is the caller graph for this function:

◆ addVariable() [5/6]

void org.turro.indicator.AbstractIndicator.addVariable	(	String	name,
		VariableType	type,
		boolean	reversed
	)

protected

Definition at line 66 of file AbstractIndicator.java.

                                                                                {
     variables.add(new IndicatorVariable(root, name, false, type, reversed));
   }

◆ addVariable() [6/6]

void org.turro.indicator.AbstractIndicator.addVariable	(	String	name,
		VariableType	type,
		String	avoid
	)

protected

Definition at line 70 of file AbstractIndicator.java.

                                                                            {
     variables.add(new IndicatorVariable(root, name, false, type, avoid));
   }

◆ createDao()

abstract Dao org.turro.indicator.AbstractIndicator.createDao ( )

abstractprotected

Reimplemented in org.turro.indicator.StudentIndicator, org.turro.indicator.ForumIndicator, org.turro.indicator.CommonsIndicator, org.turro.indicator.DossierIndicator, org.turro.indicator.AttachmentIndicator, org.turro.indicator.ServiceIndicator, org.turro.indicator.GenericIndicator, and org.turro.indicator.ContactIndicator.

Here is the caller graph for this function:

◆ generateSiblings()

void org.turro.indicator.AbstractIndicator.generateSiblings ( )

Implements org.turro.indicator.IElephantIndicator.

Reimplemented in org.turro.indicator.DossierIndicator, and org.turro.indicator.ContactIndicator.

Definition at line 53 of file AbstractIndicator.java.

                                  {
     // Do nothing
   }

◆ getAllMatchingVariables()

List<IndicatorVariable> org.turro.indicator.AbstractIndicator.getAllMatchingVariables ( String root )

Implements org.turro.indicator.IElephantIndicator.

Definition at line 112 of file AbstractIndicator.java.

                                                                       {
     return variables.stream().filter(v -> v.permits(root) && v.getType().isMatching()).collect(Collectors.toList());
   }

◆ getAllRankingVariables()

List<IndicatorVariable> org.turro.indicator.AbstractIndicator.getAllRankingVariables ( String root )

Implements org.turro.indicator.IElephantIndicator.

Definition at line 107 of file AbstractIndicator.java.

                                                                      {
     return variables.stream().filter(v -> v.permits(root) && v.getType().isRanking()).collect(Collectors.toList());
   }

◆ getAllVariables()

List<IndicatorVariable> org.turro.indicator.AbstractIndicator.getAllVariables ( )

Implements org.turro.indicator.IElephantIndicator.

Definition at line 97 of file AbstractIndicator.java.

                                                    {
     return variables;
   }

◆ getDao()

Dao org.turro.indicator.AbstractIndicator.getDao ( )

Definition at line 228 of file AbstractIndicator.java.

                       {
     if(_dao == null) {
       _dao = createDao();
     }
     return _dao;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEntityPaths()

Stream<String> org.turro.indicator.AbstractIndicator.getEntityPaths ( String root )

Implements org.turro.indicator.IElephantIndicator.

Reimplemented in org.turro.indicator.GenericIndicator.

Definition at line 215 of file AbstractIndicator.java.

                                                     {
     throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
   }

◆ getPath()

String org.turro.indicator.AbstractIndicator.getPath ( Object entity )

protected

Definition at line 173 of file AbstractIndicator.java.

                                           {
     return (entity instanceof String) ? (String) entity : Entities.getController(entity).getPath();
   }

Here is the call graph for this function:

◆ getRoot()

String org.turro.indicator.AbstractIndicator.getRoot ( )

Implements org.turro.indicator.IElephantIndicator.

Definition at line 58 of file AbstractIndicator.java.

                           {
     return root;
   }

◆ getSiblingPaths()

Stream<GenericSiblings> org.turro.indicator.AbstractIndicator.getSiblingPaths ( String entityPath )

Implements org.turro.indicator.IElephantIndicator.

Reimplemented in org.turro.indicator.GenericIndicator.

Definition at line 220 of file AbstractIndicator.java.

                                                                     {
     throw new UnsupportedOperationException("Not supported yet."); //To change body of generated methods, choose Tools | Templates.
   }

◆ getValue() [1/2]

double org.turro.indicator.AbstractIndicator.getValue	(	IndicatorVariable	variable,
		Object	entity
	)

Implements org.turro.indicator.IElephantIndicator.

Reimplemented in org.turro.indicator.StudentIndicator, org.turro.indicator.DossierIndicator, org.turro.indicator.ServiceIndicator, and org.turro.indicator.ContactIndicator.

Definition at line 117 of file AbstractIndicator.java.

                                                                     {
     return 0.0;
   }

◆ getValue() [2/2]

double org.turro.indicator.AbstractIndicator.getValue	(	IndicatorVariable	variable,
		Object	entity,
		String	relatedPath
	)

Implements org.turro.indicator.IElephantIndicator.

Reimplemented in org.turro.indicator.StudentIndicator, and org.turro.indicator.ContactIndicator.

Definition at line 122 of file AbstractIndicator.java.

                                                                                         {
     return 0.0;
   }

◆ getVariable()

IndicatorVariable org.turro.indicator.AbstractIndicator.getVariable ( String name )

Implements org.turro.indicator.IElephantIndicator.

Definition at line 102 of file AbstractIndicator.java.

                                                     {
     return getVariables().stream().filter(v -> name.equals(v.getName())).findAny().get();
   }

Here is the call graph for this function:

◆ getVariables()

List<IndicatorVariable> org.turro.indicator.AbstractIndicator.getVariables ( )

Implements org.turro.indicator.IElephantIndicator.

Definition at line 92 of file AbstractIndicator.java.

                                                 {
     return variables.stream().filter(v -> root.equals(v.getRoot())).collect(Collectors.toList());
   }

Here is the caller graph for this function:

◆ initExternalVariables()

abstract void org.turro.indicator.AbstractIndicator.initExternalVariables ( )

abstractprotected

Reimplemented in org.turro.indicator.StudentIndicator, org.turro.indicator.ForumIndicator, org.turro.indicator.CommonsIndicator, org.turro.indicator.DossierIndicator, org.turro.indicator.AttachmentIndicator, org.turro.indicator.ServiceIndicator, org.turro.indicator.GenericIndicator, and org.turro.indicator.ContactIndicator.

Here is the caller graph for this function:

◆ initIndicator()

void org.turro.indicator.AbstractIndicator.initIndicator ( )

Implements org.turro.indicator.IElephantIndicator.

Definition at line 43 of file AbstractIndicator.java.

                               {
     initVariables();
   }

Here is the call graph for this function:

◆ initVariables()

abstract void org.turro.indicator.AbstractIndicator.initVariables ( )

abstractprotected

Reimplemented in org.turro.indicator.StudentIndicator, org.turro.indicator.ForumIndicator, org.turro.indicator.CommonsIndicator, org.turro.indicator.DossierIndicator, org.turro.indicator.AttachmentIndicator, org.turro.indicator.ServiceIndicator, org.turro.indicator.GenericIndicator, and org.turro.indicator.ContactIndicator.

Here is the caller graph for this function:

◆ itsMine() [1/2]

boolean org.turro.indicator.AbstractIndicator.itsMine ( IndicatorVariable variable )

Implements org.turro.indicator.IElephantIndicator.

Definition at line 245 of file AbstractIndicator.java.

                                                      {
     return getVariables().contains(variable);
   }

Here is the call graph for this function:

◆ itsMine() [2/2]

boolean org.turro.indicator.AbstractIndicator.itsMine ( String root )

Implements org.turro.indicator.IElephantIndicator.

Definition at line 240 of file AbstractIndicator.java.

                                       {
     return this.root.equals(root);
   }

Here is the caller graph for this function:

◆ postprocess()

void org.turro.indicator.AbstractIndicator.postprocess	(	IndicatorVariable	variable,
		IPreprocessor	postprocessor,
		String	entityRoot,
		String	relatedRoot
	)

Implements org.turro.indicator.IElephantIndicator.

Definition at line 165 of file AbstractIndicator.java.

                                                                                                                           {
     if(postprocessor instanceof ProcessRanking) {
       postprocessRankingVariable(createDao(), postprocessor, variable, entityRoot);
     } else if(postprocessor instanceof ProcessMatching) {
       postprocessMatchingVariable(createDao(), postprocessor, variable, entityRoot, relatedRoot);
     }
   }

Here is the call graph for this function:

◆ postprocessMatchingVariable()

void org.turro.indicator.AbstractIndicator.postprocessMatchingVariable	(	Dao	dao,
		IPreprocessor	postprocessor,
		IndicatorVariable	variable,
		String	entityRoot,
		String	relatedRoot
	)

protected

Definition at line 209 of file AbstractIndicator.java.

210 {}

Here is the caller graph for this function:

◆ postprocessRankingVariable()

void org.turro.indicator.AbstractIndicator.postprocessRankingVariable	(	Dao	dao,
		IPreprocessor	postprocessor,
		IndicatorVariable	variable,
		String	entityRoot
	)

protected

Reimplemented in org.turro.indicator.ContactIndicator.

Definition at line 207 of file AbstractIndicator.java.

208 {}

Here is the caller graph for this function:

◆ prepareIndicator()

void org.turro.indicator.AbstractIndicator.prepareIndicator ( )

Implements org.turro.indicator.IElephantIndicator.

Definition at line 48 of file AbstractIndicator.java.

                                  {
     initExternalVariables();
   }

Here is the call graph for this function:

◆ preprocess()

void org.turro.indicator.AbstractIndicator.preprocess	(	IndicatorVariable	variable,
		IPreprocessor	preprocessor,
		String	entityRoot,
		String	relatedRoot
	)

Implements org.turro.indicator.IElephantIndicator.

Definition at line 150 of file AbstractIndicator.java.

                                                                                                                         {
     if(variable.isPreprocess()) {
       if(root.equals(variable.getRoot())) {
         if(preprocessor instanceof ProcessRanking) {
           processRankingVariable(createDao(), preprocessor, variable, entityRoot);
         } else if(preprocessor instanceof ProcessMatching) {
           processMatchingVariable(createDao(), preprocessor, variable, entityRoot, relatedRoot);
         }
       } else {
         Indicators.getIndicator(variable).preprocess(variable, preprocessor, entityRoot, relatedRoot);
       }
     }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processMatchingVariable()

abstract void org.turro.indicator.AbstractIndicator.processMatchingVariable	(	Dao	dao,
		IPreprocessor	preprocessor,
		IndicatorVariable	variable,
		String	entityRoot,
		String	relatedRoot
	)

abstractprotected

Reimplemented in org.turro.indicator.StudentIndicator, org.turro.indicator.ForumIndicator, org.turro.indicator.CommonsIndicator, org.turro.indicator.DossierIndicator, org.turro.indicator.AttachmentIndicator, org.turro.indicator.ServiceIndicator, org.turro.indicator.GenericIndicator, and org.turro.indicator.ContactIndicator.

Here is the caller graph for this function:

◆ processRankingVariable()

abstract void org.turro.indicator.AbstractIndicator.processRankingVariable	(	Dao	dao,
		IPreprocessor	preprocessor,
		IndicatorVariable	variable,
		String	entityRoot
	)

abstractprotected

Reimplemented in org.turro.indicator.StudentIndicator, org.turro.indicator.ForumIndicator, org.turro.indicator.CommonsIndicator, org.turro.indicator.DossierIndicator, org.turro.indicator.AttachmentIndicator, org.turro.indicator.ServiceIndicator, org.turro.indicator.GenericIndicator, and org.turro.indicator.ContactIndicator.

Here is the caller graph for this function:

◆ readIndicator()

IndicatorResult org.turro.indicator.AbstractIndicator.readIndicator	(	String	storeClass,
		String	indicator
	)

Implements org.turro.indicator.IElephantIndicator.

Definition at line 127 of file AbstractIndicator.java.

                                                                             {
     String v[] = indicator.split("\\s*\\.\\s*");
     int index = 0;
     WhereClause wc = new WhereClause();
     if(v.length == 2) {
       wc.addClause("select new org.turro.indicator.IndicatorResult(sum(ranking), count(ranking))");
     } else {
       wc.addClause("select new org.turro.indicator.IndicatorResult(sum(matching), count(matching))");
     }
     wc.addClause("from " + storeClass);
     wc.addClause("where entityPath like :entityPath");
     wc.addNamedValue("entityPath", convertPathToLike(v[index++], root));
     if(v.length == 3) {
       wc.addClause("and relatedPath like :relatedPath");
       wc.addNamedValue("relatedPath", convertPathToLike(v[index++], relatedRoot));
     }
     wc.addClause("and concept like :indicator");
     wc.addNamedValue("indicator", convertIndicatorToLike(v[index]));
     
     return (IndicatorResult) getDao().getSingleResultOrNull(wc);
   }

Here is the call graph for this function:

Member Data Documentation

◆ root

String org.turro.indicator.AbstractIndicator.root

protected

Definition at line 40 of file AbstractIndicator.java.

◆ variables

List<IndicatorVariable> org.turro.indicator.AbstractIndicator.variables = new ArrayList<>()

protected

Definition at line 39 of file AbstractIndicator.java.

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

AbstractIndicator.java

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addExternalVariable()

◆ addVariable() [1/6]

◆ addVariable() [2/6]

◆ addVariable() [3/6]

◆ addVariable() [4/6]

◆ addVariable() [5/6]

◆ addVariable() [6/6]

◆ createDao()

◆ generateSiblings()

◆ getAllMatchingVariables()

◆ getAllRankingVariables()

◆ getAllVariables()

◆ getDao()

◆ getEntityPaths()

◆ getPath()

◆ getRoot()

◆ getSiblingPaths()

◆ getValue() [1/2]

◆ getValue() [2/2]

◆ getVariable()

◆ getVariables()

◆ initExternalVariables()

◆ initIndicator()

◆ initVariables()

◆ itsMine() [1/2]

◆ itsMine() [2/2]

◆ postprocess()

◆ postprocessMatchingVariable()

◆ postprocessRankingVariable()

◆ prepareIndicator()

◆ preprocess()

◆ processMatchingVariable()

◆ processRankingVariable()

◆ readIndicator()

Member Data Documentation

◆ root

◆ variables