org.metawidget.inspector.impl.BaseXmlInspectorConfig Maven / Gradle / Ivy
// Metawidget
//
// This file is dual licensed under both the LGPL
// (http://www.gnu.org/licenses/lgpl-2.1.html) and the EPL
// (http://www.eclipse.org/org/documents/epl-v10.php). As a
// recipient of Metawidget, you may choose to receive it under either
// the LGPL or the EPL.
//
// Commercial licenses are also available. See http://metawidget.org
// for details.
package org.metawidget.inspector.impl;
import java.io.InputStream;
import org.metawidget.config.iface.NeedsResourceResolver;
import org.metawidget.config.iface.ResourceResolver;
import org.metawidget.config.impl.SimpleResourceResolver;
import org.metawidget.inspector.impl.propertystyle.PropertyStyle;
import org.metawidget.util.simple.ObjectUtils;
import org.w3c.dom.Document;
/**
* Base class for BaseXmlInspectorConfig configurations.
*
* Handles specifying XML file input.
*
* @author Richard Kennard
*/
// Note: we considered the approach from this blog post...
//
// http://passion.forco.de/content/emulating-self-types-using-java-generics-simplify-fluent-api-implementation
//
// ...but ultimately it becomes too cumbersome for the end-user to instantiate configs (see comments
// at the bottom of that blog post)
public class BaseXmlInspectorConfig
implements NeedsResourceResolver {
//
// Private members
//
private String mDefaultFile;
private ResourceResolver mResourceResolver;
private InputStream[] mInputStreams;
private Document[] mDocuments;
private PropertyStyle mRestrictAgainstObject;
private boolean mInferInheritanceHierarchy;
private PropertyStyle mValidateAgainstClasses;
//
// Public methods
//
/**
* Sets the InputStreams of multiple XML files.
*
* This method is more advanced than setInputStream, as it combines multiple files,
* but it is slightly more cumbersome to configure in metawidget.xml.
*
* @return this, as part of a fluent interface
*/
public BaseXmlInspectorConfig setInputStreams( InputStream... streams ) {
mInputStreams = streams;
return this;
}
/**
* Sets the InputStream of the XML.
*
* @return this, as part of a fluent interface
*/
public BaseXmlInspectorConfig setInputStream( InputStream stream ) {
mDefaultFile = null;
mInputStreams = new InputStream[] { stream };
// Fluent interface
return this;
}
public void setResourceResolver( ResourceResolver resourceResolver ) {
mResourceResolver = resourceResolver;
}
/**
* Sets the XML using a DOM Document.
*
* @return this, as part of a fluent interface
*/
public BaseXmlInspectorConfig setDocuments( Document... document ) {
mDefaultFile = null;
mDocuments = document;
// Fluent interface
return this;
}
/**
* Sets the property style used to restrict XML inspection against the given Object. This
* applies when mixing XML-based Inspectors (e.g. XmlInspector) and
* Object-based Inspectors (e.g. PropertyTypeInspector) in the same
* application (i.e. via CompositeInspector).
*
* You may encounter a problem whereby the Object-based Inspector will always stop
* at null or recursive references, whereas the XML Inspector (which
* have no knowledge of Object values) will continue. This can lead to the
* WidgetBuilders constructing a UI for a null Object, which may upset
* some WidgetProcessors (e.g. BeansBindingProcessor). To resolve
* this, you can set BaseXmlInspectorConfig.setRestrictAgainstObject, whereby the
* XML-based Inspector will do a check for null or recursive
* references, and not return any XML. In addition, setting restrictAgainstObject
* allows the XML Inspector to traverse child relationships and infer their types
* using the Object. This saves having to explicitly specify those relationships in the XML.
*
* @return this, as part of a fluent interface
*/
public BaseXmlInspectorConfig setRestrictAgainstObject( PropertyStyle restrictAgainstObject ) {
mRestrictAgainstObject = restrictAgainstObject;
// Fluent interface
return this;
}
/**
* Sets whether to infer the inheritance heirarchy of types in the XML by looking them up
* against corresponding Java Classes. This saves having to explicitly specify the
* inheritance heirarchy in the XML.
*
* Note this does not infer child relationships. For that, use
* setRestrictAgainstObject (which also implies
* setInferInheritanceHierarchy).
*
* @return this, as part of a fluent interface
*/
public BaseXmlInspectorConfig setInferInheritanceHierarchy( boolean inferInheritanceHierarchy ) {
mInferInheritanceHierarchy = inferInheritanceHierarchy;
// Fluent interface
return this;
}
/**
* Sets the property style used to validate whether properties defined in the XML match those
* defined by the corresponding Java Classes.
*
* @return this, as part of a fluent interface
*/
public BaseXmlInspectorConfig setValidateAgainstClasses( PropertyStyle validateAgainstClasses ) {
mValidateAgainstClasses = validateAgainstClasses;
// Fluent interface
return this;
}
@Override
public boolean equals( Object that ) {
if ( this == that ) {
return true;
}
if ( !ObjectUtils.nullSafeClassEquals( this, that ) ) {
return false;
}
if ( !ObjectUtils.nullSafeEquals( mDefaultFile, ( (BaseXmlInspectorConfig) that ).mDefaultFile ) ) {
return false;
}
if ( !ObjectUtils.nullSafeEquals( mResourceResolver, ( (BaseXmlInspectorConfig) that ).mResourceResolver ) ) {
return false;
}
if ( !ObjectUtils.nullSafeEquals( mInputStreams, ( (BaseXmlInspectorConfig) that ).mInputStreams ) ) {
return false;
}
if ( !ObjectUtils.nullSafeEquals( mDocuments, ( (BaseXmlInspectorConfig) that ).mDocuments ) ) {
return false;
}
if ( !ObjectUtils.nullSafeEquals( mRestrictAgainstObject, ( (BaseXmlInspectorConfig) that ).mRestrictAgainstObject ) ) {
return false;
}
if ( !ObjectUtils.nullSafeEquals( mInferInheritanceHierarchy, ( (BaseXmlInspectorConfig) that ).mInferInheritanceHierarchy ) ) {
return false;
}
if ( !ObjectUtils.nullSafeEquals( mValidateAgainstClasses, ( (BaseXmlInspectorConfig) that ).mValidateAgainstClasses ) ) {
return false;
}
return true;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode( mDefaultFile );
hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode( mResourceResolver );
hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode( mInputStreams );
hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode( mDocuments );
hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode( mRestrictAgainstObject );
hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode( mInferInheritanceHierarchy );
hashCode = 31 * hashCode + ObjectUtils.nullSafeHashCode( mValidateAgainstClasses );
return hashCode;
}
//
// Protected methods
//
protected void setDefaultFile( String defaultFile ) {
mDefaultFile = defaultFile;
}
protected InputStream[] getInputStreams() {
if ( mInputStreams == null && mDefaultFile != null ) {
return new InputStream[] { getResourceResolver().openResource( mDefaultFile ) };
}
return mInputStreams;
}
protected ResourceResolver getResourceResolver() {
if ( mResourceResolver == null ) {
// Support programmatic configuration (ie. mResourceResolver is specified automatically
// by ConfigReader when using metawidget.xml, but is generally not set manually when
// people are creating Inspectors by hand)
return new SimpleResourceResolver();
}
return mResourceResolver;
}
protected Document[] getDocuments() {
return mDocuments;
}
protected PropertyStyle getRestrictAgainstObject() {
return mRestrictAgainstObject;
}
protected boolean isInferInheritanceHierarchy() {
return mInferInheritanceHierarchy;
}
protected PropertyStyle getValidateAgainstClasses() {
return mValidateAgainstClasses;
}
}