SEO_Domain_Index_rgScheme (SEO Domain Index Crisopeya IM v1.0.0 API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

SEO Domain Index
Crisopeya IM
v1.0.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.crisopeya.product.SEO_Domain_Index_rg
Class SEO_Domain_Index_rgScheme

java.lang.Object
  net.crisopeya.product.SEO_Domain_Index_rg.SEO_Domain_Index_rgStaticScheme
      net.crisopeya.product.SEO_Domain_Index_rg.SEO_Domain_Index_rgScheme

All Implemented Interfaces:: IMScheme, Scheme

public class SEO_Domain_Index_rgScheme
extends SEO_Domain_Index_rgStaticScheme
implements Scheme
extends SEO_Domain_Index_rgStaticScheme
implements Scheme

Utility class for SEO_Domain_Index_rgStaticScheme to overcome the limitations of Java Interface static method declarations. It provides public access methods to SEO_Domain_Index_rgStaticScheme functionality to implement the Scheme interface.

Scheme Information

This class is a member of the Crisopeya IM Scheme Framework. The IM scheme information is divided into six classes according to the application layer scope and the interface implementation, as shown in the following diagram:

Crisopeya IM Scheme
Framework Diagram

For additional information about the Crisopeya IM Scheme Framework see SEO_Domain_Index_rgStaticModel, SEO_Domain_Index_rgModel, SEO_Domain_Index_rgDbStaticModel, SEO_Domain_Index_rgDbModel, SEO_Domain_Index_rgUiStaticModel and SEO_Domain_Index_rgUiModel

Java Interfaces limitation to define static methods

The Java programming language does not support static method declarations in an Interface because Java "static" keyword means a global definition, and the VM does not use virtual dispatch to resolve static methods. Java doesn't really have class variables and class methods, the "static" keyword means they are global.

The SEO_Domain_Index_rgStaticScheme class implements the SEO_Domain_Index_rg Information Module Scheme using static fields as best improves application performance. On the other hand, this SEO_Domain_Index_rgScheme utility class is implemented provides the CRISOPEYA Platform the possibility to access that information through the public Scheme interface. Combining both implementations you can get better performance.

This same approach is used in all Crisopeya IM Scheme Framework classes, as shown in the following diagram:

Crisopeya IM Scheme Interfaces
Diagram

Inmutable Scheme

Most of the CRISOPEYA IM Scheme information is immutable and cannot be modified. Therefore, the Collections.unmodifiableCollection wrapper is used in the getter methods. For additional information about the SEO Domain Index (external link) IM inmutable scheme see SEO_Domain_Index_rgStaticScheme.

Version:: 1.0.0, 09/28/08
Author:: C-SGE (crisopeya software generation engine)
See Also:: SEO_Domain_Index_rgStaticScheme, Scheme

Field Summary

Fields inherited from class net.crisopeya.product.SEO_Domain_Index_rg.SEO_Domain_Index_rgStaticScheme
`COLUMNNAMES, DATATYPES, fieldOrdering, fieldPriority, FIELDSSIZE, label, longLabels, MODELNAME, NULLALLOWED, NUMBEROFFIELDS, shortLabels, uiColumnSizes, UIMODELNAME, UNIQUE`

Constructor Summary
`SEO_Domain_Index_rgScheme()`

Method Summary
`List<String>`	`getColumnNames()` Gets the database column names for each field in the SEO Domain Index (external link) Information Module.
`List<String>`	`getDatatypes()` Gets the datatype for each field in the SEO Domain Index (external link) Information Module.
`List<String>`	`getFieldOrdering()` Gets the field ordering direction for the default ordering configuration for the SEO Domain Index (external link) Information Module.
`List<Integer>`	`getFieldPriority()` Gets the field priority for the default ordering configuration for the SEO Domain Index (external link) Information Module.
`List<String>`	`getFieldsSize()` Gets the datatype size on the database for the fields in the SEO Domain Index (external link) Information Module.
`String`	`getGuiModelName()` Gets the name of the SEO Domain Index (external link) Information Module for the User Interface.
`int`	`getLabel()` Gets the index of the SEO Domain Index (external link) Information Module "label" field.
`List<String>`	`getLongLabels()` Gets the long labels for the SEO Domain Index (external link) Information Module fields.
`String`	`getModelName()` Gets the internal name of the SEO Domain Index (external link) Information Module.
`List<Boolean>`	`getNullAllowed()` Gets the boolean array with the "null allowed" constraint information for each field in the SEO Domain Index (external link) Information Module.
`int`	`getNumberOfFields()` Gets the number of fields of the SEO Domain Index (external link) Information Module.
`List<String>`	`getShortLabels()` Gets the short labels for the SEO Domain Index (external link) Information Module fields.
`List<Integer>`	`getUiColumnSizes()` Gets the User Interface column size for each field in the SEO Domain Index (external link) Information Module.
`List<Boolean>`	`getUnique()` Gets the boolean array with the "unique" constraint information for each field in the SEO Domain Index (external link) Information Module.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

SEO_Domain_Index_rgScheme

public SEO_Domain_Index_rgScheme()

Method Detail

getModelName

public String getModelName()

Gets the internal name of the SEO Domain Index (external link) Information Module.

Specified by:: getModelName in interface IMScheme

Returns:: The IM internal name.
See Also:: SEO_Domain_Index_rgStaticScheme.MODELNAME

getGuiModelName

public String getGuiModelName()

Gets the name of the SEO Domain Index (external link) Information Module for the User Interface.

Returns:: The IM User Interface name.
See Also:: SEO_Domain_Index_rgStaticScheme.UIMODELNAME

getNumberOfFields

public int getNumberOfFields()

Gets the number of fields of the SEO Domain Index (external link) Information Module.

Returns:: The IM number of fields.
See Also:: SEO_Domain_Index_rgStaticScheme.NUMBEROFFIELDS

getUnique

public List<Boolean> getUnique()

Gets the boolean array with the "unique" constraint information for each field in the SEO Domain Index (external link) Information Module.

Specified by:: getUnique in interface IMScheme

Returns:: The "unique" constraint boolean array.
See Also:: SEO_Domain_Index_rgStaticScheme.UNIQUE

getNullAllowed

public List<Boolean> getNullAllowed()

Gets the boolean array with the "null allowed" constraint information for each field in the SEO Domain Index (external link) Information Module.

Specified by:: getNullAllowed in interface IMScheme

Returns:: The "null allowed" constraint boolean array.
See Also:: SEO_Domain_Index_rgStaticScheme.NULLALLOWED

getLabel

public int getLabel()

Gets the index of the SEO Domain Index (external link) Information Module "label" field.

Specified by:: getLabel in interface IMScheme

Returns:: The index of the "label" field.
See Also:: SEO_Domain_Index_rgStaticScheme.label

getColumnNames

public List<String> getColumnNames()

Gets the database column names for each field in the SEO Domain Index (external link) Information Module.

Specified by:: getColumnNames in interface IMScheme

Returns:: The IM database column names.
See Also:: SEO_Domain_Index_rgStaticScheme.COLUMNNAMES

getDatatypes

public List<String> getDatatypes()

Gets the datatype for each field in the SEO Domain Index (external link) Information Module.

Specified by:: getDatatypes in interface IMScheme

Returns:: The IM fields datatypes.
See Also:: SEO_Domain_Index_rgStaticScheme.DATATYPES

getFieldsSize

public List<String> getFieldsSize()

Gets the datatype size on the database for the fields in the SEO Domain Index (external link) Information Module.

Specified by:: getFieldsSize in interface IMScheme

Returns:: The IM datatypes sizes.
See Also:: SEO_Domain_Index_rgStaticScheme.FIELDSSIZE

getFieldPriority

public List<Integer> getFieldPriority()

Gets the field priority for the default ordering configuration for the SEO Domain Index (external link) Information Module.

Specified by:: getFieldPriority in interface IMScheme

Returns:: The IM field priority.
See Also:: SEO_Domain_Index_rgStaticScheme.fieldPriority, SEO_Domain_Index_rgStaticScheme.fieldOrdering

getFieldOrdering

public List<String> getFieldOrdering()

Gets the field ordering direction for the default ordering configuration for the SEO Domain Index (external link) Information Module.

Specified by:: getFieldOrdering in interface IMScheme

Returns:: The IM field ordering direction.
See Also:: SEO_Domain_Index_rgStaticScheme.fieldOrdering, SEO_Domain_Index_rgStaticScheme.fieldPriority

getLongLabels

public List<String> getLongLabels()

Gets the long labels for the SEO Domain Index (external link) Information Module fields.

Specified by:: getLongLabels in interface IMScheme

Returns:: The IM fields long labels.
See Also:: SEO_Domain_Index_rgStaticScheme.longLabels

getShortLabels

public List<String> getShortLabels()

Gets the short labels for the SEO Domain Index (external link) Information Module fields.

Specified by:: getShortLabels in interface IMScheme

Returns:: The IM fields short labels.
See Also:: SEO_Domain_Index_rgStaticScheme.shortLabels

getUiColumnSizes

public List<Integer> getUiColumnSizes()

Gets the User Interface column size for each field in the SEO Domain Index (external link) Information Module.

Specified by:: getUiColumnSizes in interface IMScheme

Returns:: The IM fields UI column size.
See Also:: SEO_Domain_Index_rgStaticScheme.uiColumnSizes