Extending Refinement Actions - Revision history

imported>Nicolas at 15:49, 19 April 2011

2011-04-19T15:49:51Z

@@ Line 97: / Line 97: @@
 File name validation will be treated apart, as a separate feature request, as it does not seem directly related to this topic.
 [[Category:Developer documentation]]
 [[Category:Design proposal]]

2011-04-19T15:29:13Z

← Older revision		Revision as of 15:29, 19 April 2011
Line 94:		Line 94:
	}		}

	== File Name Validation ==		=== File Name Validation ===

	File name validation will be treated apart, as a separate feature request, as it does not seem directly related to this topic.		File name validation will be treated apart, as a separate feature request, as it does not seem directly related to this topic.

2011-04-19T14:54:45Z

File Name Validation

@@ Line 96: / Line 96: @@
 == File Name Validation ==
-It looks preferable to externalize file name validation, making it independent from refinement.
+File name validation will be treated apart, as a separate feature request, as it does not seem directly related to this topic.
 [[Category:Developer documentation]]
 [[Category:Design proposal]]

2011-04-19T14:52:38Z

Extension Points

← Older revision		Revision as of 14:52, 19 April 2011
Line 36:		Line 36:
	=== Extension Points ===		=== Extension Points ===

	~~{{TODO\|~~the notion of refinement ~~seems too specific~~ to be ~~put in database plug-in org.rodinp.core; use a more general vocabulary, talking about "creating~~ a new component from an existing one~~"}}~~		For generality, the notion of ''refinement'' here is to be understood as an operation that makes a new component (the target) from an existing one (the source), without any constraint about the results.

			Machine refinement and context extension are particular cases of ''refinement''.

	==== refinements ====		==== refinements ====

2011-04-19T14:49:18Z

API Change

← Older revision		Revision as of 14:49, 19 April 2011
Line 90:		Line 90:
	IProgressMonitor monitor) throws RodinDBException;		IProgressMonitor monitor) throws RodinDBException;

	}

	~~=== New API ===~~

	~~in org.rodinp.core.RodinCore.java:~~

	/**
	* Refines the given root to a file with the given name. In case the
	* refinement fails, an error is logged and <code>null</code> is returned.
	* The given source root is not modified by this operation.
	* In the context of this plug-in, the notion of refinement is to be
	* understood as an operation that creates a new component from an existing
	* one, without any constraint about the results.
	*
	* @param sourceRoot
	* the root to refine
	* @param targetName
	* name of the refined target, including the extension, which
	* must give the same root type as the source root
	* @param monitor
	* a progress monitor, or <code>null</code> if progress report is
	* not desired
	* @return refined root or <code>null</code>
	*/
	~~// FIXME either check same root type, or take a bare name~~
	~~public static IInternalElement refine(IInternalElement sourceRoot,~~
	~~String targetName, IProgressMonitor monitor) {~~
	~~return new RefinementProcessor(sourceRoot).refine(targetName, monitor);~~
	}		}

2011-04-19T14:47:05Z

IRefinementParticipant

← Older revision		Revision as of 14:47, 19 April 2011
Line 68:		Line 68:

	==== IRefinementParticipant ====		==== IRefinementParticipant ====

			This interface is implemented by clients who want to participate in refinements.

	public interface IRefinementParticipant {		public interface IRefinementParticipant {

2011-04-19T14:45:47Z

IRefinementParticipant

← Older revision		Revision as of 14:45, 19 April 2011
Line 70:		Line 70:

	public interface IRefinementParticipant {		public interface IRefinementParticipant {

	void process(IInternalElement ~~root~~);		/**
			* Modifies the given target root in order to make it (partially or
			* entirely) a refinement of the given source root. The source root is not
			* modified by this operation.
			*
			* @param targetRoot
			* the target root
			* @param sourceRoot
			* the source of the refinement
			* @param monitor
			* a progress monitor, or <code>null</code>
			* @throws RodinDBException
			* if a database operation fails
			*/
			void process(IInternalElement targetRoot, IInternalElement sourceRoot,
			IProgressMonitor monitor) throws RodinDBException;

	}		}

2011-04-19T14:38:27Z

refinementUI

← Older revision		Revision as of 14:38, 19 April 2011
Line 61:		Line 61:
	* UIMessages		* UIMessages
	** refinement id		** refinement id
	** ~~context~~ menu ~~text~~		** label (contextual menu)
	** title (new component window)		** title (new component window)
	** message (new component window)		** message (new component window)

2011-04-14T15:59:27Z

New API

← Older revision		Revision as of 15:59, 14 April 2011
Line 80:		Line 80:

	/**		/**
	* Refines the given root. In case the refinement fails, an error is logged		* Refines the given root to a file with the given name. In case the
	* and <code>null</code> is returned.		* refinement fails, an error is logged and <code>null</code> is returned.
	* The given source root is not modified by this operation.		* The given source root is not modified by this operation.
	* In the context of this plug-in, the notion of refinement is to be		* In the context of this plug-in, the notion of refinement is to be
Line 89:		Line 89:
	* @param sourceRoot		* @param sourceRoot
	* the root to refine		* the root to refine
			* @param targetName
			* name of the refined target, including the extension, which
			* must give the same root type as the source root
			* @param monitor
			* a progress monitor, or <code>null</code> if progress report is
			* not desired
	* @return refined root or <code>null</code>		* @return refined root or <code>null</code>
	*/		*/
	public static IInternalElement refine(IInternalElement sourceRoot) {		// FIXME either check same root type, or take a bare name
	return new RefinementProcessor(sourceRoot).refine();		public static IInternalElement refine(IInternalElement sourceRoot,
			String targetName, IProgressMonitor monitor) {
			return new RefinementProcessor(sourceRoot).refine(targetName, monitor);
	}		}

2011-04-13T09:48:08Z

New API

← Older revision		Revision as of 09:48, 13 April 2011
Line 80:		Line 80:

	/**		/**
	* ~~Returns an ordered list of refinement participants for~~ the given root		* Refines the given root. In case the refinement fails, an error is logged
	* element type. The order is computed from contributions. In case ~~a cycle~~		* and <code>null</code> is returned.
	* ~~occurs,~~ <code>null</code> is returned.		* The given source root is not modified by this operation.
			* In the context of this plug-in, the notion of refinement is to be
			* understood as an operation that creates a new component from an existing
			* one, without any constraint about the results.
	*		*
	* @param ~~rootType~~		* @param sourceRoot
	* a root ~~element type~~		* the root to refine
	* @return ~~a list of refinement participants,~~ or <code>null</code>		* @return refined root or <code>null</code>
	*/		*/
	public static ~~List<IRefinementParticipant> getRefinementParticipants~~(		public static IInternalElement refine(IInternalElement sourceRoot) {
	~~IInternalElementType<?> rootType~~) {		return new RefinementProcessor(sourceRoot).refine();
	return ~~Collections~~.~~emptyList~~();
	}		}