org.turro.indicator.IndicatorVariable Class Reference

Inheritance diagram for org.turro.indicator.IndicatorVariable:

Collaboration diagram for org.turro.indicator.IndicatorVariable:

Public Member Functions
	IndicatorVariable (String root, String name, boolean preprocess, VariableType type)
	IndicatorVariable (String root, String name, boolean preprocess, VariableType type, boolean reversed)
	IndicatorVariable (String root, String name, boolean preprocess, VariableType type, String avoid)
	IndicatorVariable (String root, String name, boolean preprocess, VariableType type, boolean reversed, String avoid)
String	toString ()
String	getFullName ()
String	getRoot ()
String	getName ()
boolean	isPreprocess ()
VariableType	getType ()
boolean	isReversed ()
Set< String >	getAvoid ()
boolean	permits (String root)
long	getMissingValue ()
int	hashCode ()
boolean	equals (Object obj)

Static Public Member Functions
static IndicatorVariable	result (String root, VariableType type)

Detailed Description

Author

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

Definition at line 31 of file IndicatorVariable.java.

Constructor & Destructor Documentation

IndicatorVariable() [1/4]

org.turro.indicator.IndicatorVariable.IndicatorVariable	(	String	root,
		String	name,
		boolean	preprocess,
		VariableType	type
	)

Definition at line 38 of file IndicatorVariable.java.

                                                                                            {
    this(root, name, preprocess, type, false, null);
  }

Here is the caller graph for this function:

IndicatorVariable() [2/4]

org.turro.indicator.IndicatorVariable.IndicatorVariable	(	String	root,
		String	name,
		boolean	preprocess,
		VariableType	type,
		boolean	reversed
	)

Definition at line 42 of file IndicatorVariable.java.

                                                                                                              {
    this(root, name, preprocess, type, reversed, null);
  }

IndicatorVariable() [3/4]

org.turro.indicator.IndicatorVariable.IndicatorVariable	(	String	root,
		String	name,
		boolean	preprocess,
		VariableType	type,
		String	avoid
	)

Definition at line 46 of file IndicatorVariable.java.

                                                                                                          {
    this(root, name, preprocess, type, false, avoid);
  }

IndicatorVariable() [4/4]

org.turro.indicator.IndicatorVariable.IndicatorVariable	(	String	root,
		String	name,
		boolean	preprocess,
		VariableType	type,
		boolean	reversed,
		String	avoid
	)

Definition at line 50 of file IndicatorVariable.java.

                                                                                                                            {
    this.root = root;
    this.name = name;
    this.preprocess = preprocess;
    this.type = type;
    this.reversed = reversed;
    this.avoid = Strings.isBlank(avoid) ? null : new HashSet<>(Strings.csvToList(avoid));
  }

Member Function Documentation

equals()

boolean org.turro.indicator.IndicatorVariable.equals

(

Object

obj

)

Definition at line 115 of file IndicatorVariable.java.

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

Here is the call graph for this function:

getAvoid()

Set<String> org.turro.indicator.IndicatorVariable.getAvoid

(

)

Definition at line 88 of file IndicatorVariable.java.

                                {
    return avoid;
  }

getFullName()

String org.turro.indicator.IndicatorVariable.getFullName

(

)

Definition at line 64 of file IndicatorVariable.java.

                              {
    return root + ":" + getName();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getMissingValue()

long org.turro.indicator.IndicatorVariable.getMissingValue

(

)

Definition at line 96 of file IndicatorVariable.java.

                                {
    return isReversed() ? Long.MAX_VALUE : 0;
  }

Here is the call graph for this function:

getName()

String org.turro.indicator.IndicatorVariable.getName

(

)

Definition at line 72 of file IndicatorVariable.java.

                          {
    return name;
  }

Here is the caller graph for this function:

getRoot()

String org.turro.indicator.IndicatorVariable.getRoot

(

)

Definition at line 68 of file IndicatorVariable.java.

                          {
    return root;
  }

Here is the caller graph for this function:

getType()

VariableType org.turro.indicator.IndicatorVariable.getType

(

)

Definition at line 80 of file IndicatorVariable.java.

                                {
    return type;
  }

hashCode()

int org.turro.indicator.IndicatorVariable.hashCode

(

)

Definition at line 105 of file IndicatorVariable.java.

                        {
    int hash = 3;
    hash = 97 * hash + Objects.hashCode(this.root);
    hash = 97 * hash + Objects.hashCode(this.name);
    hash = 97 * hash + (this.preprocess ? 1 : 0);
    hash = 97 * hash + Objects.hashCode(this.type);
    return hash;
  }

isPreprocess()

boolean org.turro.indicator.IndicatorVariable.isPreprocess

(

)

Definition at line 76 of file IndicatorVariable.java.

                                {
    return preprocess;
  }

Here is the caller graph for this function:

isReversed()

boolean org.turro.indicator.IndicatorVariable.isReversed

(

)

Definition at line 84 of file IndicatorVariable.java.

                              {
    return reversed;
  }

Here is the caller graph for this function:

permits()

boolean org.turro.indicator.IndicatorVariable.permits

(

String

root

)

Definition at line 92 of file IndicatorVariable.java.

                                      {
    return avoid == null || !avoid.contains(root);
  }

result()

static IndicatorVariable org.turro.indicator.IndicatorVariable.result ( String  root, VariableType  type  )

static

Definition at line 100 of file IndicatorVariable.java.

                                                                         {
    return new IndicatorVariable(root, "*", false, type);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

toString()

String org.turro.indicator.IndicatorVariable.toString

(

)

Definition at line 60 of file IndicatorVariable.java.

                           {
    return getFullName();
  }

Here is the call graph for this function:

---

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

• IndicatorVariable.java