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

     * @param url the navigator url to display metadata for
     * @return the HTML for the metadata display page
     */
    private static String getMetadataPage(NavFrameOwner owner, NavAddress url) {
        
        CALFeatureMetadata metadata = NavAddressHelper.getMetadata(owner, url);
        StringBuilder buffer = new StringBuilder();
        
        // display the page header
        buffer.append(getMetadataPageHeader(owner, url));

View Full Code Here


        buffer.append(getPageLocationHtml(owner, url));
        buffer.append("<table cellpadding='1' cellspacing='0' width='100%' bgcolor='#E0E0E0'><tr><td nowrap>");
        buffer.append("<font face='arial' size='2'>");
        
        CALFeatureMetadata metadata = NavAddressHelper.getMetadata(owner, url);
        
        // add links to the module vaults
        if (metadata instanceof ModuleMetadata) {
            
            ModuleName moduleName = ModuleName.make(url.getBase());

View Full Code Here

     * @return the HTML for a link to the related feature's page, for a disabled link if the related feature has no metadata.
     */
    private static String getRelatedFeatureLinkHtml(NavFrameOwner owner, NavAddress address, String displayName) {
        // If there is metadata for a feature, then provide a link to it.
        // Otherwise, show the name of the feature in a disabled style.
        CALFeatureMetadata featureMetadata = NavAddressHelper.getMetadata(owner, address);
        
        if (featureMetadata != null) {
            return getLinkHtml(address, displayName);
        } else {
            return getDisabledHtml(displayName);

View Full Code Here

            
            for (final ModuleName friendModule : friendModules) {
                NavAddress moduleAddress = NavAddress.getAddress(CALFeatureName.getModuleFeatureName(friendModule));
                String displayText = NavAddressHelper.getDisplayText(owner, moduleAddress);
                
                CALFeatureMetadata friendMetadata = NavAddressHelper.getMetadata(owner, moduleAddress);
                if (friendMetadata != null) {
                    buffer.append(getLinkHtml(moduleAddress, displayText));
                } else {
                    buffer.append(getDisabledHtml(displayText));
                }

View Full Code Here

     */
    private static String getPageLocationHtml(NavFrameOwner owner, NavAddress url) {


        String separator = " >> ";
        StringBuilder buffer = new StringBuilder();
        CALFeatureMetadata metadata = NavAddressHelper.getMetadata(owner, url);


        buffer.append("<table cellpadding='1' cellspacing='0' width='100%' bgcolor='#E0E0E0'><tr><td nowrap>");
        buffer.append("<font size='3'><tt>");
        buffer.append(getLinkHtml(NavAddress.getRootAddress(NavAddress.WORKSPACE_METHOD), NavigatorMessages.getString("NAV_Workspace_Location")));
        buffer.append(separator);


        if (url.getMethod() == NavAddress.SEARCH_METHOD) {
            buffer.append(NavigatorMessages.getString("NAV_SearchResults_Location"));
        
        } else if (url.getMethod() == NavAddress.COLLECTOR_METHOD) {
            buffer.append(NavAddressHelper.getDisplayText(owner, url) + NavigatorMessages.getString("NAV_Collector_Location"));
        
        } else if (url.getParameter(NavAddress.VAULT_PARAMETER) != null) {


            // add link to module
            buffer.append(getLinkHtml(url.withAllStripped(), NavAddressHelper.getDisplayText(owner, url.withAllStripped())));
            buffer.append(separator);


            // add a link to the vault
            String vault = url.getParameter(NavAddress.VAULT_PARAMETER);
            if (vault.equals(NavAddress.TYPE_VAULT_VALUE)) {
                buffer.append(NavigatorMessages.getString("NAV_TypeVault_Location"));


            } else if (vault.equals(NavAddress.CLASS_VAULT_VALUE)) {
                buffer.append(NavigatorMessages.getString("NAV_ClassVault_Location"));


            } else if (vault.equals(NavAddress.FUNCTION_VAULT_VALUE)) {
                buffer.append(NavigatorMessages.getString("NAV_FunctionVault_Location"));


            } else if (vault.equals(NavAddress.INSTANCE_VAULT_VALUE)) {
                buffer.append(NavigatorMessages.getString("NAV_InstanceVault_Location"));
            }
        
        } else if (metadata instanceof ScopedEntityMetadata || metadata instanceof ClassInstanceMetadata || metadata instanceof InstanceMethodMetadata) {
                
            String typeString = null;
            CALFeatureName featureName = metadata.getFeatureName();
            
            // add link to module
            ModuleName moduleName = featureName.toModuleName();
            MetaModule module = owner.getPerspective().getMetaModule(moduleName);
            NavAddress moduleUrl = NavAddress.getAddress(module);
            buffer.append(getLinkHtml(NavAddress.getAddress(module), moduleName.toSourceText()));
            buffer.append(separator);


            // add link to parent or vault
            if (metadata instanceof FunctionMetadata) {
                NavAddress vaultUrl = moduleUrl.withParameter(NavAddress.VAULT_PARAMETER, NavAddress.FUNCTION_VAULT_VALUE);
                buffer.append(getLinkHtml(vaultUrl, NavigatorMessages.getString("NAV_FunctionVault_Location")));
                typeString = NavigatorMessages.getString("NAV_Function_Location");


            } else if (metadata instanceof TypeConstructorMetadata) {
                NavAddress vaultUrl = moduleUrl.withParameter(NavAddress.VAULT_PARAMETER, NavAddress.TYPE_VAULT_VALUE);
                buffer.append(getLinkHtml(vaultUrl, NavigatorMessages.getString("NAV_TypeVault_Location")));
                typeString = NavigatorMessages.getString("NAV_Type_Location");
                
            } else if (metadata instanceof TypeClassMetadata) {
                NavAddress vaultUrl = moduleUrl.withParameter(NavAddress.VAULT_PARAMETER, NavAddress.CLASS_VAULT_VALUE);
                buffer.append(getLinkHtml(vaultUrl, NavigatorMessages.getString("NAV_ClassVault_Location")));
                typeString = NavigatorMessages.getString("NAV_Class_Location");
                
            } else if (metadata instanceof ClassInstanceMetadata) {
                NavAddress vaultUrl = moduleUrl.withParameter(NavAddress.VAULT_PARAMETER, NavAddress.INSTANCE_VAULT_VALUE);
                buffer.append(getLinkHtml(vaultUrl, NavigatorMessages.getString("NAV_InstanceVault_Location")));
                typeString = NavigatorMessages.getString("NAV_Instance_Location");                    
            
            } else if (metadata instanceof InstanceMethodMetadata) {
                CALFeatureName methodFeatureName = metadata.getFeatureName();
                NavAddress parentUrl = NavAddress.getAddress(CALFeatureName.getClassInstanceFeatureName(
                    methodFeatureName.toInstanceIdentifier(), methodFeatureName.toModuleName()));
                
                buffer.append(getLinkHtml(parentUrl, NavAddressHelper.getDisplayText(owner, parentUrl, ScopedEntityNamingPolicy.UNQUALIFIED)));
                typeString = NavigatorMessages.getString("NAV_InstanceMethod_Location");

View Full Code Here

                            WorkspaceResource metadataResource = it.next();
                            ResourceIdentifier identifier = metadataResource.getIdentifier();
                            CALFeatureName featureName = (CALFeatureName)identifier.getFeatureName();
                            Locale locale = LocalizedResourceName.localeOf(identifier.getResourceName());
                            if (getWorkspace().getMetaModule(featureName.toModuleName()) != null) {
                                CALFeatureMetadata metadata = getWorkspace().getMetadata(featureName, locale);
                                if (!getWorkspace().saveMetadata(metadata)) {
                                    System.out.println("Error saving metadata for " + featureName + " for " + (locale == null ? "default" : locale.toString()) + " locale.");
                                } 
                            }
                        }

View Full Code Here

     * @return the metadata associated with the entity the address points to or
     * null if there is no metadata associated with the address
     */
    public static CALFeatureMetadata getMetadata(NavFrameOwner owner, NavAddress address) {
        
        CALFeatureMetadata metadata = null;
        NavAddressMethod method = address.getMethod();


        if (method == NavAddress.WORKSPACE_METHOD || method == NavAddress.SEARCH_METHOD) {
            return null;

View Full Code Here

            int argNum = Integer.parseInt(address.getParameter(NavAddress.ARGUMENT_PARAMETER));
            
            if (address.getMethod() == NavAddress.INSTANCE_METHOD_METHOD) {
                NavAddress parentAddress = NavAddress.getAddress(address.toFeatureName()); // this strips out the &argument=n parameter
                
                CALFeatureMetadata parentFeatureMetadata = getMetadata(owner, parentAddress);
                if (parentFeatureMetadata == null) {
                    return false;
                }
                
                InstanceMethodMetadata parentMetadata = (InstanceMethodMetadata)parentFeatureMetadata;
                
                ArgumentMetadata[] arguments = parentMetadata.getArguments();
                arguments[argNum] = (ArgumentMetadata) metadata;
                parentMetadata.setArguments(arguments);
                
                return saveMetadata(owner, parentAddress, parentMetadata);
                
            } else {
                NavAddress parentAddress = address.withAllStripped();
                
                CALFeatureMetadata parentFeatureMetadata = getMetadata(owner, parentAddress);
                if (parentFeatureMetadata == null) {
                    return false;
                }
                
                FunctionalAgentMetadata parentMetadata = (FunctionalAgentMetadata)parentFeatureMetadata;

View Full Code Here

     * @param metadata the metadata object to refresh
     * @return true if the metadata was refreshed, false otherwise
     */
    public static boolean refreshMetadata(NavFrameOwner owner, NavAddress address, CALFeatureMetadata metadata) {
        
        CALFeatureMetadata newMetadata = getMetadata(owner, address);
        
        if (metadata == null) {
            return false;
        }
        
        newMetadata.copyTo(metadata);
        
        return true;
    }

View Full Code Here

     * @param namingPolicy the naming policy
     * @return the display text for this address
     */
    public static String getDisplayText(NavFrameOwner owner, NavAddress address, ScopedEntityNamingPolicy namingPolicy) {


        CALFeatureMetadata metadata = getMetadata(owner, address);
        NavAddressMethod method = address.getMethod();


        // If this feature has no metadata, then there is nothing
        // sensible that we can say about it.  Just return the
        // raw text.
        if (metadata == null) {
            return address.getBase();
        }
        
        if (address.getParameter(NavAddress.ARGUMENT_PARAMETER) != null) {
            
            int argNum = Integer.parseInt(address.getParameter(NavAddress.ARGUMENT_PARAMETER));
            
            if (address.getMethod() == NavAddress.INSTANCE_METHOD_METHOD) {
                NavAddress parentAddress = NavAddress.getAddress(address.toFeatureName()); // this strips out the &argument=n parameter
                CALFeatureMetadata parentFeatureMetadata = getMetadata(owner, parentAddress);
                InstanceMethodMetadata parentMetadata = (InstanceMethodMetadata)parentFeatureMetadata;
                ArgumentMetadata[] argMetadata = parentMetadata.getArguments();
                adjustArgumentNames(owner, address, argMetadata);
                
                return argMetadata[argNum].getDisplayName();

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.