Examples of org.openquark.cal.metadata.CALFeatureMetadata

org.openquark.cal.metadata.CALFeatureMetadata
CALFeatureMetadata is a common base class for features in CAL to which some metadata can be attached.
It also includes a mechanism by which arbitrary name-value pairs can be associated with a feature.
The CALFeatureMetadata hierarchy provides extra information about various CAL entities created by the CAL compiler such as those in the ScopedEntity hierarchy as well as ModuleTypeInfo. This is analogous to the relationship between the classes in the java.beans.FeatureDescriptor hierarchy and the java.lang.reflect.AccessibleObject hierarchy. In particular, most of the information in the metadata classes is optional, and null values may be returned if the information has not been supplied. In that case, a UI tool can use the lower-level information supplied by the ScopedEntity and ModuleTypeInfo classes to provide reasonable "default" behavior. @author Bo Ilic

     * Generates the short description for a module.
     * @param moduleName the module to be described.
     */
    private void generateShortDescriptionForModule(final ModuleName moduleName) {
        ModuleTypeInfo moduleTypeInfo = programModelManager.getModuleTypeInfo(moduleName);
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getModuleFeatureName(moduleName), getLocale());
        CALDocComment docComment = moduleTypeInfo.getCALDocComment();


        generateShortDescription(metadata, docComment, new ReferenceGenerator(MODULES_SUBDIRECTORY));
    }

View Full Code Here

     * {@inheritDoc}
     */
    @Override
    void generateModuleDescription(ModuleTypeInfo moduleTypeInfo) {
        ModuleName moduleName = moduleTypeInfo.getModuleName();
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getModuleFeatureName(moduleName), getLocale());
        CALDocComment docComment = moduleTypeInfo.getCALDocComment();


        /// For a module, just generate its description and supplementary blocks
        //
        generateStandardDescription(metadata, docComment, inModulesSubdirectoryReferenceGenerator);

View Full Code Here

        // would have had their overview generated and thus the disambiguation map properly
        // populated and ready to serve out disambiguated names.
        //
        addTypeConsNameToDisambiguationMap(typeConstructor.getName().getModuleName(), typeConstructor.getName().getUnqualifiedName());
        
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getTypeConstructorFeatureName(typeConstructor.getName()), getLocale());
        CALDocComment docComment = typeConstructor.getCALDocComment();
        
        /// Generate the scope and name of the type constructor
        //
        currentPage

View Full Code Here

        // would have had their overview generated and thus the disambiguation map properly
        // populated and ready to serve out disambiguated names.
        //
        addTypeClassNameToDisambiguationMap(typeClass.getName().getModuleName(), typeClass.getName().getUnqualifiedName());
        
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getTypeClassFeatureName(typeClass.getName()), getLocale());
        CALDocComment docComment = typeClass.getCALDocComment();
        
        /// Generate the scope and name of the type class
        //
        currentPage

View Full Code Here

    /**
     * {@inheritDoc}
     */
    @Override
    void generateClassInstanceOverviewHeader(ClassInstance classInstance) {
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getClassInstanceFeatureName(classInstance), getLocale());
        CALDocComment docComment = classInstance.getCALDocComment();


        /// Generate the name of the class instance
        //
        currentPage

View Full Code Here

    /**
     * {@inheritDoc}
     */
    @Override
    void generateTypeConsDocHeader(TypeConstructor typeConstructor, int index) {
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getTypeConstructorFeatureName(typeConstructor.getName()), getLocale());
        CALDocComment docComment = typeConstructor.getCALDocComment();


        /// Generate the name of the type constructor as the header, followed by a link to the usages if necessary
        //
        String unqualifiedName = typeConstructor.getName().getUnqualifiedName();

View Full Code Here

    /**
     * {@inheritDoc}
     */
    @Override
    void generateTypeClassDocHeader(TypeClass typeClass, int index) {
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getTypeClassFeatureName(typeClass.getName()), getLocale());
        CALDocComment docComment = typeClass.getCALDocComment();


        /// Generate the name of the type class as the header, followed by a link to the usages if necessary
        //
        String unqualifiedName = typeClass.getName().getUnqualifiedName();

View Full Code Here

    /**
     * {@inheritDoc}
     */
    @Override
    void generateClassInstanceDocHeader(ClassInstance classInstance, int index) {
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getClassInstanceFeatureName(classInstance), getLocale());
        CALDocComment docComment = classInstance.getCALDocComment();


        /// Generate the name of the class instance as the header, followed by a link to the usages if necessary
        //
        currentPage

View Full Code Here

    @Override
    void beginTypeConsUsageDoc(TypeConstructor typeConstructor) {
        ModuleName moduleName = typeConstructor.getName().getModuleName();
        String typeName = typeConstructor.getName().getUnqualifiedName();
        
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getTypeConstructorFeatureName(typeConstructor.getName()), getLocale());
        CALDocComment docComment = typeConstructor.getCALDocComment();
        
        String label = labelMaker.getLabel(typeConstructor);
        
        // We delegate the generation of everything before the declaration to a helper method.

View Full Code Here

     */
    @Override
    void beginTypeClassUsageDoc(TypeClass typeClass) {
        ModuleName moduleName = typeClass.getName().getModuleName();
        
        CALFeatureMetadata metadata = getMetadata(CALFeatureName.getTypeClassFeatureName(typeClass.getName()), getLocale());
        CALDocComment docComment = typeClass.getCALDocComment();


        String label = labelMaker.getLabel(typeClass);
        
        // We delegate the generation of everything before the declaration to a helper method.

View Full Code Here

0 1 2 3

TOP

Related Classes of org.openquark.cal.metadata.CALFeatureMetadata

org.openquark.cal.caldoc.HTMLDocumentationGenerator

org.openquark.cal.services.CALFeatureName

org.openquark.cal.services.LocalizedResourceName

org.openquark.cal.services.ResourceName

org.openquark.gems.client.GemCutter

org.openquark.gems.client.navigator.NavAddressHelper

org.openquark.gems.client.navigator.NavEditorPanel

org.openquark.gems.client.navigator.NavEntityArgumentEditorSection

org.openquark.gems.client.navigator.NavFeatureEditorSection

org.openquark.gems.client.navigator.NavFrame

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.