com.technia.tvc.core.db.model

Class TypeInfo

java.lang.Object

com.technia.tvc.core.db.model.TypeInfo

All Implemented Interfaces:

com.technia.tvc.core.db.model.Deriveable, com.technia.tvc.core.db.model.SchemaInfo

public class TypeInfo
extends java.lang.Object
implements com.technia.tvc.core.db.model.Deriveable

Contains information about a type.

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

TypeInfo(java.lang.String name, java.lang.String symbolicName, boolean hidden, java.util.List<java.lang.String> attributeNames, java.lang.String derivedName, java.util.List<java.lang.String> immediateDerivativeNames, boolean abstractType, java.util.List<java.lang.String> policyNames, java.util.List<java.lang.String> fromRelNames, java.util.List<java.lang.String> toRelNames, java.util.List<java.lang.String> createPolicies) Creates a type info using the specified properties.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Returns true if the objects are equal.
static boolean	exists(java.lang.String name) Returns true if the given type exists.
java.util.List<java.lang.String>	getAttributeNames() Returns the attributes names.
java.util.List<java.lang.String>	getCreatePolicies()
TypeInfo	getDerived() Returns the TypeInfo for the type which the current type is derived from.
java.lang.String	getDerivedName() Returns the derived type name.
java.util.List<java.lang.String>	getFromRelNames() Returns the names of the relationships available on the from side.
boolean	getHasAttribute(AttributeInfo ai)
boolean	getHasAttribute(java.lang.String attribute)
java.util.List<java.lang.String>	getImmediateDerivativeNames() Returns the immediate derivative type names.
protected TypeInfo	getInfo(java.lang.String type)
static TypeInfo	getInstance(java.lang.String name) Returns a TypeInfo instance encapsulating information about the requested type.
java.lang.String	getName() Returns the name of the admin object.
java.util.List<java.lang.String>	getPolicyNames() Returns the policy names.
static java.util.List<java.lang.String>	getRootTypeNames() Returns an unmodifiable list containing the NAMES of all business types in the database, which does not have any parents
java.lang.String	getSymbolicName() Returns the symbolic type name.
java.util.List<java.lang.String>	getToRelNames() Returns the names of the relationships available on the to side.
static java.util.List<java.lang.String>	getTypeNames() Returns an unmodifiable list containing the NAMES of all business types in the database
static TreeNode	getTypeTree(java.util.List<java.lang.String> rootTypeNames) Returns given business types as a tree hierarchy.
static TreeNode	getTypeTree(java.util.List<java.lang.String> rootTypeNames, boolean includeHidden) Returns given business types as a tree hierarchy.
static TreeNode	getTypeTree(java.util.List<java.lang.String> rootTypeNames, boolean includeHidden, int levels) Returns given business types as a tree hierarchy.
static TreeNode	getTypeTree(java.lang.String rootType)
int	hashCode() Returns the hash code.
boolean	isAbstract() Returns whether the type is abstract or not.
boolean	isDerivedFrom(java.lang.String otherType) Checks if this type is a sub-type of the other type.
boolean	isHidden() Returns whether the type is hidden or not.
java.lang.String	toString() Returns a string representation suitable for debugging.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TypeInfo

protected TypeInfo(java.lang.String name,
                   java.lang.String symbolicName,
                   boolean hidden,
                   java.util.List<java.lang.String> attributeNames,
                   java.lang.String derivedName,
                   java.util.List<java.lang.String> immediateDerivativeNames,
                   boolean abstractType,
                   java.util.List<java.lang.String> policyNames,
                   java.util.List<java.lang.String> fromRelNames,
                   java.util.List<java.lang.String> toRelNames,
                   java.util.List<java.lang.String> createPolicies)

Creates a type info using the specified properties.

Method Detail

exists

public static boolean exists(java.lang.String name)
                      throws TVCException

Returns true if the given type exists.

Throws:

TVCException

getTypeTree

public static TreeNode getTypeTree(java.lang.String rootType)
                            throws TVCException

Throws:

TVCException

getTypeTree

public static TreeNode getTypeTree(java.util.List<java.lang.String> rootTypeNames)
                            throws TVCException

Returns given business types as a tree hierarchy. Only types in given List are present in hierarchy and all those types that does not have parents in given array are connected to root element. In order to get whole business type hierarchy of the system one can first call getRootTypes to get all types and then transform them into the complete type hierarchy. The value of each TreeNode is a TypeInfo

Parameters:

rootTypeNames - A list containing the NAMES of the business types that will be the immediate children of the returned TreeNode.

Throws:

TVCException

getTypeTree

public static TreeNode getTypeTree(java.util.List<java.lang.String> rootTypeNames,
                                   boolean includeHidden)
                            throws TVCException

Returns given business types as a tree hierarchy. Only types in given List are present in hierarchy and all those types that does not have parents in given array are connected to root element. In order to get whole business type hierarchy of the system one can first call getRootTypes to get all types and then transform them into the complete type hierarchy. The value of each TreeNode is a TypeInfo

Parameters:

rootTypeNames - A list containing the NAMES of the business

includeHidden - True if to include hidden objects types that will be the immediate children of the returned TreeNode.

Throws:

TVCException

getTypeTree

public static TreeNode getTypeTree(java.util.List<java.lang.String> rootTypeNames,
                                   boolean includeHidden,
                                   int levels)
                            throws TVCException

Returns given business types as a tree hierarchy. Only types in given List are present in hierarchy and all those types that does not have parents in given array are connected to root element. In order to get whole business type hierarchy of the system one can first call getRootTypes to get all types and then transform them into the complete type hierarchy. The value of each TreeNode is a TypeInfo

Parameters:

rootTypeNames - A list containing the NAMES of the business

includeHidden - True if to include hidden objects types that will be the immediate children of the returned TreeNode.

levels - How many levels to traverse the type hierarchy. If the level is less than zero the entire hierarchy will be returned.

Throws:

TVCException

Since:

5.1.1

getRootTypeNames

public static java.util.List<java.lang.String> getRootTypeNames()
                                                         throws TVCException

Returns an unmodifiable list containing the NAMES of all business types in the database, which does not have any parents

Throws:

TVCException

getTypeNames

public static java.util.List<java.lang.String> getTypeNames()
                                                     throws TVCException

Returns an unmodifiable list containing the NAMES of all business types in the database

Throws:

TVCException

getInstance

public static TypeInfo getInstance(java.lang.String name)
                            throws TVCException

Returns a TypeInfo instance encapsulating information about the requested type.

Parameters:

name - The name of the type.

Returns:

A TypeInfo instance.

Throws:

TVCException - If unable to retrieve type information in case the information has to be retrieved from the database.

getSymbolicName

public java.lang.String getSymbolicName()

Returns the symbolic type name.

isHidden

public boolean isHidden()

Returns whether the type is hidden or not.

Specified by:

isHidden in interface com.technia.tvc.core.db.model.SchemaInfo

getAttributeNames

public java.util.List<java.lang.String> getAttributeNames()

Returns the attributes names.

getHasAttribute

public boolean getHasAttribute(java.lang.String attribute)

getDerivedName

public java.lang.String getDerivedName()

Returns the derived type name.

getDerived

public TypeInfo getDerived()
                    throws TVCException

Returns the TypeInfo for the type which the current type is derived from. I.e., the parent type.

Returns:

Returns the TypeInfo for the type which the current type is derived from. I.e., the parent type.

Throws:

TVCException - If unable to load information about the parent type.

Since:

6.0.1

getImmediateDerivativeNames

public java.util.List<java.lang.String> getImmediateDerivativeNames()

Returns the immediate derivative type names.

isAbstract

public boolean isAbstract()

Returns whether the type is abstract or not.

getPolicyNames

public java.util.List<java.lang.String> getPolicyNames()

Returns the policy names.

getFromRelNames

public java.util.List<java.lang.String> getFromRelNames()

Returns the names of the relationships available on the from side.

getToRelNames

public java.util.List<java.lang.String> getToRelNames()

Returns the names of the relationships available on the to side.

getCreatePolicies

public java.util.List<java.lang.String> getCreatePolicies()

Returns:

A list of policies that allows creating instances of this type

Since:

2016.2.0

hashCode

public int hashCode()

Returns the hash code.

equals

public boolean equals(java.lang.Object obj)

Returns true if the objects are equal.

isDerivedFrom

public boolean isDerivedFrom(java.lang.String otherType)
                      throws TVCException

Checks if this type is a sub-type of the other type.

Specified by:

isDerivedFrom in interface com.technia.tvc.core.db.model.Deriveable

Parameters:

otherType - Another type.

Returns:

Whether or not this type is derived from the other type.

Throws:

TVCException - If an error occurs.

Since:

5.0

getInfo

protected TypeInfo getInfo(java.lang.String type)
                    throws TVCException

Throws:

TVCException

getHasAttribute

public boolean getHasAttribute(AttributeInfo ai)
                        throws TVCException

Parameters:

ai - The AttributeInfo instance.

Returns:

True if this type has the specified attribute.

Throws:

TVCException - If some DB error occurs.

Since:

2013.1.0

getName

public java.lang.String getName()

Returns the name of the admin object.

Specified by:

getName in interface com.technia.tvc.core.db.model.SchemaInfo

toString

public final java.lang.String toString()

Returns a string representation suitable for debugging.

Overrides:

toString in class java.lang.Object