org.molgenis.model

Class MolgenisModelValidator

java.lang.Object

org.molgenis.model.MolgenisModelValidator

public class MolgenisModelValidator
extends Object

Constructor Summary

Constructors

Constructor and Description
MolgenisModelValidator()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addInterfaces(Model model) Add interfaces as artificial entities to the model
static void	addTypeFieldInSubclasses(Model model) In each entity of an entity subclass hierarchy a 'type' field is added to enable filtering.
static void	addXrefLabelsToEntities(Model model)
static void	copyDecoratorsToSubclass(Model model)
static void	copyDefaultXrefLabels(Model model) Default xref labels can come from: - the xref_entity (or one of its superclasses)
static void	copyFieldsToSubclassToEnforceConstraints(Model model) Copy fields to subclasses (redundantly) so this field can be part of an extra constraint.
static void	correctXrefCaseSensitivity(Model model) test for case sensitivity
static void	createLinkTablesForMrefs(Model model, MolgenisOptions options) Add link tables for many to many relationships A link table entity will have the name of [from_entity]_[to_entity] A link table has two xrefs to the from/to entity respectively The column names are those of the respective fields In case of a self reference, the second column name is '_self'
static void	moveMrefsFromInterfaceAndCopyToSubclass(Model model) As mrefs are a linking table between to other tables, interfaces cannot be part of mrefs (as they don't have a linking table).
static void	validate(Model model, MolgenisOptions options)
static void	validateExtendsAndImplements(Model model) Validate extends and implements relationships: Do superclasses actually exist Do 'implements' refer to abstract superclasses (interfaces) Do 'extends' refer to non-abstract superclasses Copy primary key to subclass to form parent/child relationships
static void	validateForeignKeys(Model model) Validate foreign key relationships: Do the xref_field and xref_label refer to fields actually exist Is the entity refered to non-abstract Does the xref_field refer to a unique field (i.e.
static void	validateHideFields(Model model)
static void	validateKeys(Model model) Validate the unique constraints Do unique field names refer to existing fields? Is there a unique column id + unique label?
static void	validateNamesAndReservedWords(Model model, MolgenisOptions options)
static void	validateNameSize(Model model, MolgenisOptions options)
static void	validateOveride(Model model) Subclasses can override fields of superclasses.
static void	validatePrimaryKeys(Model model)
static void	validateViews(Model model) Check if the view objects are an aggregate of known entities.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MolgenisModelValidator

public MolgenisModelValidator()

Method Detail

validate

public static void validate(Model model,
            MolgenisOptions options)
                     throws MolgenisModelException

Throws:

MolgenisModelException

moveMrefsFromInterfaceAndCopyToSubclass

public static void moveMrefsFromInterfaceAndCopyToSubclass(Model model)
                                                    throws MolgenisModelException

As mrefs are a linking table between to other tables, interfaces cannot be part of mrefs (as they don't have a linking table). To solve this issue, mrefs will be removed from interface class and copied to subclass.

Throws:

MolgenisModelException

validateOveride

public static void validateOveride(Model model)

Subclasses can override fields of superclasses. This should only be used with caution! Only good motivation is to limit xref type.

validateNameSize

public static void validateNameSize(Model model,
                    MolgenisOptions options)
                             throws MolgenisModelException

Throws:

MolgenisModelException

validateHideFields

public static void validateHideFields(Model model)
                               throws MolgenisModelException

Throws:

MolgenisModelException

addXrefLabelsToEntities

public static void addXrefLabelsToEntities(Model model)
                                    throws MolgenisModelException

Throws:

MolgenisModelException

validatePrimaryKeys

public static void validatePrimaryKeys(Model model)
                                throws MolgenisModelException

Throws:

MolgenisModelException

copyDefaultXrefLabels

public static void copyDefaultXrefLabels(Model model)
                                  throws MolgenisModelException

Default xref labels can come from: - the xref_entity (or one of its superclasses)

Parameters:

model -

Throws:

MolgenisModelException

addTypeFieldInSubclasses

public static void addTypeFieldInSubclasses(Model model)
                                     throws MolgenisModelException

In each entity of an entity subclass hierarchy a 'type' field is added to enable filtering. This method adds this type as 'enum' field such that all subclasses are an enum option.

Parameters:

model -

Throws:

MolgenisModelException

createLinkTablesForMrefs

public static void createLinkTablesForMrefs(Model model,
                            MolgenisOptions options)
                                     throws MolgenisModelException

Add link tables for many to many relationships

• A link table entity will have the name of [from_entity]_[to_entity]
• A link table has two xrefs to the from/to entity respectively
• The column names are those of the respective fields
• In case of a self reference, the second column name is '_self'

Parameters:

model -

Throws:

MolgenisModelException

validateViews

public static void validateViews(Model model)
                          throws MolgenisModelException

Check if the view objects are an aggregate of known entities.

Parameters:

model -

Throws:

MolgenisModelException

validateForeignKeys

public static void validateForeignKeys(Model model)
                                throws MolgenisModelException

Validate foreign key relationships:

Do the xref_field and xref_label refer to fields actually exist
Is the entity refered to non-abstract
Does the xref_field refer to a unique field (i.e. foreign key)

Parameters:

model -

Throws:

MolgenisModelException

validateKeys

public static void validateKeys(Model model)
                         throws MolgenisModelException

Validate the unique constraints

• Do unique field names refer to existing fields?
• Is there a unique column id + unique label?

Parameters:

model -

Throws:

MolgenisModelException

validateExtendsAndImplements

public static void validateExtendsAndImplements(Model model)
                                         throws MolgenisModelException

Validate extends and implements relationships:

• Do superclasses actually exist
• Do 'implements' refer to abstract superclasses (interfaces)
• Do 'extends' refer to non-abstract superclasses
• Copy primary key to subclass to form parent/child relationships

Parameters:

model -

Throws:

MolgenisModelException

addInterfaces

public static void addInterfaces(Model model)
                          throws MolgenisModelException

Add interfaces as artificial entities to the model

Parameters:

model -

Throws:

MolgenisModelException

Exception

validateNamesAndReservedWords

public static void validateNamesAndReservedWords(Model model,
                                 MolgenisOptions options)
                                          throws MolgenisModelException

Throws:

MolgenisModelException

correctXrefCaseSensitivity

public static void correctXrefCaseSensitivity(Model model)
                                       throws MolgenisModelException

test for case sensitivity

Throws:

MolgenisModelException

copyDecoratorsToSubclass

public static void copyDecoratorsToSubclass(Model model)
                                     throws MolgenisModelException

Parameters:

model -

Throws:

MolgenisModelException

copyFieldsToSubclassToEnforceConstraints

public static void copyFieldsToSubclassToEnforceConstraints(Model model)
                                                     throws MolgenisModelException

Copy fields to subclasses (redundantly) so this field can be part of an extra constraint. E.g. a superclass has non-unique field 'name'; in the subclass it is said to be unique and a copy is made to capture this constraint in the table for the subclass.

Parameters:

model -

Throws:

MolgenisModelException