iadftobeanconverter.java

esri的ArcGIS Server超级学习模板程序（for java）

package com.esri.solutions.jitk.web.tasks.mapcomp;

import java.util.List;

import com.esri.adf.web.ags.data.AGSLocalMapResource;
import com.esri.adf.web.ags.data.AGSMapResource;
import com.esri.adf.web.ags.data.AGSUser;
import com.esri.adf.web.aims.data.AIMSMapResource;
import com.esri.adf.web.aws.data.AWSMapResource;
import com.esri.adf.web.data.GISResource;
import com.esri.adf.web.data.WebContext;
import com.esri.adf.web.data.geometry.WebExtent;
import com.esri.adf.web.data.geometry.WebSpatialReference;
import com.esri.adf.web.wms.data.WMSMapResource;
import com.esri.aims.mtier.model.map.Layers;
import com.esri.aims.mtier.model.map.layer.Layer;
import com.esri.arcgisws.Field;
import com.esri.arcgisws.MapLayerInfo;
import com.esri.solutions.jitk.personalization.data.beans.v1.AgsInternetServiceType;
import com.esri.solutions.jitk.personalization.data.beans.v1.AgsLocalServiceType;
import com.esri.solutions.jitk.personalization.data.beans.v1.ArcImsInternetServiceType;
import com.esri.solutions.jitk.personalization.data.beans.v1.ArcImsTcpServiceType;
import com.esri.solutions.jitk.personalization.data.beans.v1.ArcWebServiceType;
import com.esri.solutions.jitk.personalization.data.beans.v1.EnvelopeN;
import com.esri.solutions.jitk.personalization.data.beans.v1.IdentityType;
import com.esri.solutions.jitk.personalization.data.beans.v1.LayerFieldListType;
import com.esri.solutions.jitk.personalization.data.beans.v1.LayerFieldType;
import com.esri.solutions.jitk.personalization.data.beans.v1.LayerListType;
import com.esri.solutions.jitk.personalization.data.beans.v1.ServiceLayerType;
import com.esri.solutions.jitk.personalization.data.beans.v1.ServiceListType;
import com.esri.solutions.jitk.personalization.data.beans.v1.ServiceType;
import com.esri.solutions.jitk.personalization.data.beans.v1.SpatialReference;
import com.esri.solutions.jitk.personalization.data.beans.v1.SpatialReferenceType;
import com.esri.solutions.jitk.personalization.data.beans.v1.WcsServiceType;
import com.esri.solutions.jitk.personalization.data.beans.v1.WfsServiceType;
import com.esri.solutions.jitk.personalization.data.beans.v1.WmsServiceType;
import com.esri.solutions.jitk.personalization.data.beans.v1.ServiceListType.ServiceItemType;
import com.esri.solutions.jitk.web.wcs.data.WCSMapResource;
import com.esri.solutions.jitk.web.wfs.data.WFSMapResource;


/**
 * Converts Java ADF objects into Map Composition Bean objects.
 */
public interface IADFToBeanConverter {

	/**
	 * Creates an Envelope using an ADF WebExtent.
	 * 
	 * @param extent	ADF Web Extent, cannot be <code>null</code>.
	 * @return {@link EnvelopeN} bean with Web Extent information.
	 */
	public EnvelopeN createEnvelope(WebExtent extent);

	/**
	 * Creates an {@link IdentityType} bean using data within an
	 * {@link AGSUser} object.
	 * 
	 * @param user	Contains user data, cannot be <code>null</code>
	 * @return {@link IdentityType} bean with data from {@link AGSUser}.
	 */
	public IdentityType createIdentityType(AGSUser user);

	/**
	 * Creates a {@link WmsServiceType} bean using data within a
	 * {@link WMSMapResource} object.
	 * 
	 * @param res	Contains WMS connection info, cannot be <code>null</code>.
	 * @return {@link WmsServiceType} that contains WMS connection info.
	 */
	public WmsServiceType createWmsServiceType(WMSMapResource res);
	
	/**
	 * Creates a {@link WfsServiceType} bean using data within a
	 * {@link WFSMapResource} object.
	 * 
	 * @param res	Contains WFS connection info, cannot be <code>null</code>.
	 * @return {@link WmsServiceType} that contains WFS connection info.
	 */
	public WfsServiceType createWfsServiceType(WFSMapResource res);	

	/**
	 * Creates a {@link ArcWebServiceType} bean using data within a
	 * {@link AWSMapResource} object.
	 * 
	 * @param res	Contains ArcWeb connection info, cannot be <code>null</code>.
	 * 
	 * @return {@link ArcWebServiceType} bean that contains ArcWeb connection info.
	 */
	public ArcWebServiceType createArcWebServiceType(AWSMapResource res);

	/**
	 * Creates an {@link IdentityType} bean using the raw values passed
	 * as arguments to this method.
	 * 
	 * @param userName				Username value.
	 * @param password				Password value, may be encrypted.
	 * @param passwordEncrypted		Flag indicating if password is
	 * 								encrypted.
	 * @return {@link IdentityType} bean that contains the specified values.
	 */
	public IdentityType createIdentityType(String userName, String password,
			boolean passwordEncrypted);

	/**
	 * Creates an {@link ArcImsInternetServiceType} bean with data from
	 * a {@link AIMSMapResource} object.
	 * 
	 * @param res		Contains ArcIMS connection info, cannot be <code>null</code>.
	 * @return {@link ArcImsInternetServiceType} that contains ArcIMS connection info.
	 */
	public ArcImsInternetServiceType createArcImsInternetServiceType(
			AIMSMapResource res);

	/**
	 * Creates an {@link ArcImsTcpServiceType} bean with data from
	 * a {@link AIMSMapResource} object.
	 * 
	 * @param res		Contains ArcIMS connection info, cannot be <code>null</code>.
	 * @return {@link ArcImsTcpServiceType} that contains ArcIMS connection info.
	 */
	public ArcImsTcpServiceType createArcImsTcpServiceType(AIMSMapResource res);
	
	/**
	 * Creates an {@link AgsLocalServiceType} bean with data from a {@link AGSLocalMapResource}
	 * object.
	 * 
	 * @param res	Contains ArcGIS Local Service info, cannot be <code>null</code>.
	 * @return {@link AgsLocalServiceType} that contains ArcGIS Local Service connection info.
	 */
	public AgsLocalServiceType createAgsLocalServiceType(AGSLocalMapResource res);

	/**
	 * Creates a {@link LayerFieldType} from an ArcGIS Server Field.
	 * 
	 * @param field		ArcGIS Field information, from a Layer, cannot be <code>null</code>.
	 * @return {@link LayerFieldType} that contains ArcGIS Field information.
	 */
	public LayerFieldType createLayerFieldType(Field field);

	/**
	 * Creates a {@link LayerFieldListType} from an ArcGIS Server {@link
	 * MapLayerInfo} object.
	 * 
	 * @param info	Contains Layer Information, 
	 * 				including fields, cannot be <code>null</code>.
	 * @return {@link LayerFieldListType} of all Fields within the {@link MapLayerInfo}.
	 */
	public LayerFieldListType createLayerFieldListType(MapLayerInfo info);

	/**
	 * Creates a {@link ServiceLayerType} from an ArcGIS Server {@link MapLayerInfo}
	 * object.
	 * 
	 * @param info	Contains Layer Information, cannot be <code>null</code>.
	 * @return {@link ServiceLayerType} that contains data from a {@link MapLayerInfo}.
	 */
	public ServiceLayerType createServiceLayerType(MapLayerInfo info);

	/**
	 * Creates a {@link ServiceLayerType} from an ArcIMS Layer object.
	 * 
	 * @param layer ArcIMS Layer, cannot be <code>null</code>.
	 * 
	 * @return {@link ServiceLayerType} that contains data from an ArcIMS Layer.
	 */
	public ServiceLayerType createServiceLayerType(Layer layer);
	
	/**
	 * Creates a {@link ServiceLayerType} from an WMS Layer object.
	 * 
	 * @param layer WMS Layer, cannot be <code>null</code>.
	 * 
	 * @return {@link ServiceLayerType} that contains data from a WMS Layer.
	 */
	public ServiceLayerType createServiceLayerType(com.esri.wms.client.Layer layer);
	
	/**
	 * Creates a {@link AgsInternetServiceType} from a {@link AGSMapResource}
	 * object.
	 * 
	 * @param res	Contains ArcGIS Server Internet connection info, cannot be <code>null</code>.
	 * @return {@link AgsInternetServiceType} with data from {@link AGSMapResource}.
	 */
	public AgsInternetServiceType createAgsInternetServiceType(AGSMapResource res);

	/**
	 * Creates a {@link WcsServiceType} from a {@link WCSMapResource}
	 * object.
	 * 
	 * @param res	Contains WCS connection info, cannot be <code>null</code>.
	 * @return {@link WcsServiceType} with data from {@link WCSMapResource}.
	 */
	public WcsServiceType createWcsServiceType(WCSMapResource res);
	
	/**
	 * Creates a {@link ServiceItemType} from a {@link GISResource}.
	 * 
	 * @param res	Contains connection info to a GIS Resource, 
	 * 				cannot be <code>null</code>.
	 * @return {@link ServiceItemType} with data from {@link GISResource}.
	 */
	public ServiceItemType createServiceItemType(GISResource res);

	/**
	 * Creates multiple {@link ServiceType} within {@link ServiceListType}
	 * of all GIS Resources within {@link WebContext}.
	 * 
	 * @param ctx	Contains 0 or more GIS Resources, cannot be <code>null</code>.
	 * @return {@link ServiceListType} with {@link ServiceType}s created from  GIS Resources.
	 */
	public ServiceListType createServiceListType(WebContext ctx);

	/**
	 * Creates a {@link SpatialReferenceType} from the ADF's {@link WebSpatialReference}.
	 * 
	 * @param wsr Contains Spatial Reference data, cannot be <code>null</code>.
	 * @return {@link SpatialReference} with Spatial Reference data.
	 */
	public SpatialReferenceType createSpatialReference(WebSpatialReference wsr);
	
	/**
	 * Creates a {@link LayerListType} from a list of ArcIMS Layers.
	 * 
	 * @param layers  Set of ArcIMS layers, cannot be <code>null</code>.
	 * @return Contains information for a Map Composition for the ArcIMS Layers.
	 */
	public LayerListType createLayerListType(Layers layers);
	
	/**
	 * Creates a {@link LayerListType} from a list of WMS layers.
	 * 
	 * @param allLayers Set of WMS Layers, cannot be <code>null</code>.
	 * @return Contains information for a Map Composition for the WMS layers.
	 */
	public LayerListType createLayerListType(
			List<com.esri.wms.client.Layer> allLayers);
	
	/**
	 * Creates a {@link LayerListType} from a list of ArcGIS Server layers.
	 * 
	 * @param layerInfos Layer information for all layers within an ArcGIS Server service, 
	 * 					 cannot be <code>null</code>.
	 * @return Contains information for a Map Composition for ArcGIS Server service layers.
	 */
	public LayerListType createLayerListType(MapLayerInfo[] layerInfos);
	
	/**
	 * Returns messages that were generated by performing operations in this
	 * object.
	 * 
	 * @return	List of messages.
	 */
	public List<String> getMessages ();
	
	/**
	 * Clears the messages that were generated by performing operations in this
	 * object.
	 */
	public void clearMessages ();
}