TableMetadata

TableMetadata

TableMetadata

This component acts as a generic container for metadata about a database table. It provides utility methods to interact with the metadata and encapsulates the checking for and defalut values of metadata attributes.

Metadata

Instantiating 

	        

	    
	


getTableDefinition()
Returns a struct of structs. Each sub-struct contains the keys type,default,nullable. The name of the key for each sub-struct is the desired name of the column in the table.

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
None

          
        

	
getTableName()
Returns the name of the table that this metadata represents

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
None

          
        

	
init()
Initializes the instance data for the component

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
None

          
        

	
parseArrayProperty()
Parses the data out of cfproperty tag for array properties

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              data
	              struct
	              Yes
	              
	              
	              
	            

			
          
        

	
parseComponentMetadata()
Parses the given component metadata structure and generates metadata that can be used by the DBGateway components.

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              md
	              struct
	              Yes
	              
	              
	              Metadata for a component that follows the farcry convention of using  tags to declare database specific information. This would typically be the result of calling getMetaData() on the component.
	            

			
          
        

	
parseMetadata()
Parses the given structure and generates metadata that can be used by the DBGateway components.

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              md
	              struct
	              Yes
	              
	              
	              Metadata for a component that follows the farcry convention of using  tags to declare database specific information. This would typically be the result of calling getMetaData() on the component.
	            

			
	            

	              bForceRefresh
	              boolean
	              No
	              false
	              
	              Flag that will force a refresh of the metadata if required.
	            

			
          
        

	
parseProperty()
Parses the data out of cfproperty tag metadata and inserts default values for unspecified attributes

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              data
	              struct
	              Yes