ValidateThis API Documentation

ValidateThis.core.annotationTypeReaders
Class BaseAnnotationTypeReader

WEB-INF.cftags.component
        extended by ValidateThis.core.BaseMetadataProcessor
            extended by ValidateThis.core.annotationTypeReaders.BaseAnnotationTypeReader
Direct Known Subclasses:
AnnotationTypeReader_JSON , AnnotationTypeReader_VTML , AnnotationTypeReader_XML

public class BaseAnnotationTypeReader
extends BaseMetadataProcessor

I am a responsible for reading and processing an annotation.


Constructor Summary
init()
          I build a new XMLFileReader
 
Method Summary
 boolean annotationsAreThisFormat(array properties)
          I determine whether the annotation value contains this type of format
 boolean isThisFormat(string annotationValue)
          I determine whether the annotation value contains this type of format
 void loadRules(string objectType, any metadataSource)
          I take the metadata and reformat it into a struct
private struct normalizeValidations(struct allRules)
          I take the rules and post-process them using other property metadata
private void processConditions(any conditions)
          I translate condition annotation metadata into an array to be used by the BaseMetadataProcessor
private void processContexts(any contexts)
          I translate context annotation metadata into an array to be used by the BaseMetadataProcessor
private array processJSONOrList(any theItems)
          I translate annotation metadata into an array to be used by the BaseMetadataProcessor
private any processPropertyDescs(any theProperties)
          I simply pass the call on to my parent
private any processPropertyRules(string objectType, any theProperties)
          I simply pass the call on to my parent
 
Methods inherited from class ValidateThis.core.BaseMetadataProcessor
determineLabel, getValidations
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init()
I build a new XMLFileReader

Method Detail

annotationsAreThisFormat

public boolean annotationsAreThisFormat(array properties)
I determine whether the annotation value contains this type of format

Parameters:
properties

isThisFormat

public boolean isThisFormat(string annotationValue)
I determine whether the annotation value contains this type of format

Parameters:
annotationValue

loadRules

public void loadRules(string objectType, any metadataSource)
I take the metadata and reformat it into a struct

Overrides:
loadRules in class BaseMetadataProcessor
Parameters:
objectType - the type of object for which a BOValidator is being created
metadataSource - the object metadata

normalizeValidations

private struct normalizeValidations(struct allRules)
I take the rules and post-process them using other property metadata

Parameters:
allRules

processConditions

private void processConditions(any conditions)
I translate condition annotation metadata into an array to be used by the BaseMetadataProcessor

Overrides:
processConditions in class BaseMetadataProcessor
Parameters:
conditions

processContexts

private void processContexts(any contexts)
I translate context annotation metadata into an array to be used by the BaseMetadataProcessor

Overrides:
processContexts in class BaseMetadataProcessor
Parameters:
contexts

processJSONOrList

private array processJSONOrList(any theItems)
I translate annotation metadata into an array to be used by the BaseMetadataProcessor

Parameters:
theItems

processPropertyDescs

private any processPropertyDescs(any theProperties)
I simply pass the call on to my parent

Overrides:
processPropertyDescs in class BaseMetadataProcessor
Parameters:
theProperties

processPropertyRules

private any processPropertyRules(string objectType, any theProperties)
I simply pass the call on to my parent

Overrides:
processPropertyRules in class BaseMetadataProcessor
Parameters:
objectType - the type of object for which a BOValidator is being created
theProperties

ValidateThis API Documentation