Posts tagged "CFC Introspection"

Where ColdFusion Builder finds my CFCs?

ColdFusion Builder makes working with components really easy. It understands the component resolution technique and generates the fully qualified name of the components, in compliance with server. The fully qualified names of the component are available in multiple places in ColdFusion Builder:

  • CFC wizard: When extending or implementing component, fully qualified name of the components are listed in CFC dialog box.
  • Content Assist: When content assist is invoked for component name, the fully qualified name of the component is proposed to you.
  • Open CFC wizard: Lists all the components in workspace with fully qualified names.

ColdFusion Builder also resolves the components in a given page by checking the component that can be resolved with available details in the project and the server.

Source/Location of the component

ColdFusion Builder searches the source/location of component in the following order of priority:

  1. ColdFusion Administrator mapping: ColdFusion Builder reads the mapping details from the server and uses the mapping name and location to build the fully qualified name.
  2. Note: ColdFusion Builder reads the mapping from the server only if RDS details are provided for the server. Project should be associated with server to see the qualified names of the component in the mapping location.

  3. ColdFusion Server Document root: If document root of the server is provided, then ColdFusion Builder generates the fully qualified names of the components.
  4. Note: Project should be associated with the server to see the qualified name of component from webroot.

  5. Current Project: Components in current project are available with fully qualified name.
  6. Linked Folders: Components in linked folders are available with fully qualified name.
  7. Note: When you create a linked folder with ColdFusion Builder using the Project Wizard or Project Property preferences, check the option Use Link folder name. If you use Eclipse, the option is checked by default.

    If the option is checked, component qualified name is generated by prefixing the name of the linked folder of the components inside the linked folder.

    For example, C:\MyCFCs\folder1\sample.cfc where MyCFCs is the name of linked folder is resolved as mycfcs.folder1.sample.

  8. Custom tag path: ColdFusion Builder reads the custom tag path details from the server and uses the tag path location to build the fully qualified name.

Note: ColdFusion Builder reads the custom tag location from server only if RDS details are provided for the server. Project should be associated with server to see the qualified names of the component in the custom tag location.

Creating qualified name for the components

ColdFusion Builder creates qualified names of the components from different location as discussed in the previous section. You have the option to create qualified names when you launch ColdFusion Builder. Locate the option from Preferences > Startup > Build CFC in project, at start-up.

Note: Uncheck this option if you don’t want ColdFusion Builder to create qualified names for you.

Points to remember

  • To see the components from the mappings/ custom tag paths, Build server settings must be checked (Preferences > ColdFusion > Server Settings).
  • If server is offline, old mapping details are used to build CFCs.
  • If server is edited, added, or refreshed, the mapping settings/custom tag paths are refreshed based on option selected in Server Settings section.
  • Based on the server component resolution technique, the components are generated in the following order:
  1. Current directory
  2. ColdFusion administrator mappings
  3. ColdFusion Document root
  4. Relative to project and linked folder
  5. Custom tag path
  • Components are resolved in ColdFusion Builder in the same way as the server resolves the components.
  • Number of features (Code Assist, Quick Fix, Hyperlink, CFC Introspection, and CFC Wizard) depends on building and resolving CFCs in ColdFusion Builder.
  • Keep a tab on options (you have selected in the Preferences) which controls the building and resolving of CFCs.

Now use this information when you build application that deals with hundreds of components and let ColdFusion Builder, not you, worry about your CFCs.