Constructor Detail

• BasePipeline

  public BasePipeline()

Method Detail

• setReadOnly

  public void setReadOnly(boolean readOnly)

• isReadOnly

  public boolean isReadOnly()

• getMaximumInspectionDepth

  public int getMaximumInspectionDepth()

• setMaximumInspectionDepth

  public void setMaximumInspectionDepth(int maximumInspectionDepth)

  Sets the maximum depth of inspection.

  Metawidget renders most non-primitve types by using nested Metawidgets. This value limits the number of nestings.

  This can be useful in detecing cyclic references. Although BaseObjectInspector -derived Inspectors are capable of detecting cyclic references, other Inspectors may not be. For example, BaseXmlInspector-derived Inspectors cannot because they only test types, not actual objects.

  Parameters:

  maximumInspectionDepth - 0 for top-level only, 1 for 1 level deep etc.

• setNeedsConfiguring

  public void setNeedsConfiguring()

• configureOnce

  public void configureOnce()

  Configures the Metawidget, then sets a flag so that subsequent calls to configureOnce do nothing.

  The flag can be reset by calling setNeedsConfiguring.

• setInspector

  public void setInspector(Inspector inspector)

• getInspector

  public Inspector getInspector()

• getInspectionResultProcessors

  public List<InspectionResultProcessor<M>> getInspectionResultProcessors()

  Gets the List of InspectionResultProcessors.

  This pipeline only references a single Inspector and single WidgetBuilder. It relies on CompositeInspector and CompositeWidgetBuilder to support multiples, which allows the combination algorithm itself to be pluggable.

  We use a List of InspectionResultProcessors, however, so as to be consistent with WidgetProcessors. Note ordering of InspectionResultProcessors is significant.

• setInspectionResultProcessors

  public void setInspectionResultProcessors(InspectionResultProcessor<M>... inspectionResultProcessors)

• addInspectionResultProcessor

  public void addInspectionResultProcessor(InspectionResultProcessor<M> inspectionResultProcessor)

• removeInspectionResultProcessor

  public void removeInspectionResultProcessor(InspectionResultProcessor<M> inspectionResultProcessors)

• setWidgetBuilder

  public void setWidgetBuilder(WidgetBuilder<W,M> widgetBuilder)

• getWidgetBuilder

  public WidgetBuilder<W,M> getWidgetBuilder()

• getWidgetProcessors

  public List<WidgetProcessor<W,M>> getWidgetProcessors()

  Gets the List of WidgetProcessors.

  This pipeline only references a single Inspector and single WidgetBuilder. It relies on CompositeInspector and CompositeWidgetBuilder to support multiples, which allows the combination algorithm itself to be pluggable.

  We cannot use this same approach for WidgetProcessors, however, because we want to support event handling. We want to allow, for example:

  metawidget.addWidgetProcessor( new WidgetProcessor() {
...handle event...
}

  This mechanism cannot be delegated to a CompositeWidgetProcessor, because WidgetProcessors must be immutable, and we want to allow event handlers that are non-static anonymous inner classes.

  There, we use a List of WidgetProcessors. Note ordering of WidgetProcessors is significant.

• setWidgetProcessors

  public void setWidgetProcessors(WidgetProcessor<W,M>... widgetProcessors)

• addWidgetProcessor

  public void addWidgetProcessor(WidgetProcessor<W,M> widgetProcessor)

• removeWidgetProcessor

  public void removeWidgetProcessor(WidgetProcessor<W,M> widgetProcessor)

• getLayout

  public Layout<W,C,M> getLayout()

• setLayout

  public void setLayout(Layout<W,C,M> layout)

  Set the Layout to use for the Metawidget.

• inspect

  public String inspect(Object toInspect,
               String type,
               String... names)

  Inspect the given Object according to the given path, and return the result as a String conforming to inspection-result-1.0.xsd.

  This method mirrors the Inspector interface. Internally it looks up the Inspector to use. It is a useful hook for subclasses wishing to inspect different Objects using our same Inspector.

  In addition, this method runs the InspectionResultProcessors.

• inspectAsDom

  public E inspectAsDom(Object toInspect,
               String type,
               String... names)

  Inspect the given Object according to the given path, and return the result as a String conforming to inspection-result-1.0.xsd.

  This method mirrors the DomInspector interface. Internally it looks up the Inspector to use. It is a useful hook for subclasses wishing to inspect different Objects using our same Inspector.

  In addition, this method runs the InspectionResultProcessors.

• buildWidgets

  public void buildWidgets(E inspectionResult)
                    throws Exception

  Build widgets from the given XML inspection result.

  Note: the BasePipeline expects the XML to be passed in externally, rather than fetching it itself, because some XML inspections may be asynchronous.

  Throws:

  Exception

• initNestedPipeline

  public void initNestedPipeline(BasePipeline<W,C,E,M> nestedPipeline,
                        Map<String,String> attributes)

  Copies this pipeline's values into another pipeline. Useful for when a Metawidget creates a nested Metawidget.

  Special behaviour is:

  • the given pipeline has setReadOnly if the current pipeline has setReadOnly or if the attributes map contains READ_ONLY
  • the given pipeline is initialised with a maximumInspectionDepth of 1 less than the current maximumInspectionDepth. This is so that, as nesting continues, eventually the maximumInspectionDepth reaches zero
  • the given pipeline is initialised with the same Inspectors, InspectionResultProcessors, WidgetBuilders, WidgetProcessors and Layouts as the current pipeline. This is safe because they are all immutable

  Parameters:

  attributes - may be null

• buildCompoundWidget

  protected void buildCompoundWidget(E entity)
                              throws Exception

  Build a compound widget by iterating through children of the given element, calling buildWidget and addWidget on each.

  Throws:

  Exception

• stringToElement

  protected abstract E stringToElement(String xml)

• elementToString

  protected abstract String elementToString(E element)

  Serialize the given element to an XML String.

  Parameters:

  element - the element to serialize. May be null.

• getFirstChildElement

  protected abstract E getFirstChildElement(E parent)

• getNextSiblingElement

  protected abstract E getNextSiblingElement(E element)

• getElementName

  protected abstract String getElementName(E element)

• getAttributesAsMap

  protected abstract Map<String,String> getAttributesAsMap(E element)

• configure

  protected abstract void configure()

• startBuild

  protected void startBuild()

• processInspectionResult

  protected E processInspectionResult(Object inspectionResult,
                          Object toInspect,
                          String type,
                          String... names)

  Parameters:

  inspectionResult - may be a String of XML, or an E, depending on whether the Inspector was a DomInspector

• getAdditionalAttributes

  protected abstract Map<String,String> getAdditionalAttributes(W widget)

  Returns additional attributes associated with the widget.

  At the very least, this method should be implemented to support returning additional attributes from stubs.

  Returns:

  the additional attributes. May be null

• buildWidget

  protected W buildWidget(String elementName,
              Map<String,String> attributes)

• processWidget

  protected W processWidget(W widget,
                String elementName,
                Map<String,String> attributes)

  Process the built widget.

• buildNestedMetawidget

  protected abstract M buildNestedMetawidget(Map<String,String> attributes)
                                                throws Exception

  Throws:

  Exception

• getPipelineOwner

  protected abstract M getPipelineOwner()

• layoutWidget

  protected void layoutWidget(W widget,
                  String elementName,
                  Map<String,String> attributes)

  Lays out the built and processed widget.

• endBuild

  protected void endBuild()