com.esri.adf.web.ejb.data
Class EJBTocFunctionality

java.lang.Object
  extended by com.esri.adf.web.ejb.data.EJBTocFunctionality
All Implemented Interfaces:
GISFunctionality, TocFunctionality, java.io.Serializable

Deprecated. This class is deprecated as of ArcGIS Java Server 9.3.1, no replacement

@Deprecated
public class EJBTocFunctionality
extends java.lang.Object
implements TocFunctionality, java.io.Serializable

See Also:
Serialized Form

Field Summary
protected  java.lang.Class customLayerContentClass
          Deprecated.  
protected  java.lang.String customLayerContentClassName
          Deprecated.  
protected  EJBMapResource ejbMapResource
          Deprecated.  
protected static TocNodeContent placeHolderNodeContent
          Deprecated.  
 
Fields inherited from interface com.esri.adf.web.data.TocFunctionality
FUNCTIONALITY_NAME
 
Constructor Summary
EJBTocFunctionality()
          Deprecated.  
 
Method Summary
 void addPatches(TocNode node, int layerId)
          Deprecated.  
 void createTocHierarchy(TocNode parentNode)
          Deprecated.  Creates the content hierarchy for this TOC.
 void destroyFunctionality()
          Deprecated.  The cleanup chores (such as releasing held resources) for the functionality must be performed in this method.
 java.lang.String getCustomLayerContentClassName()
          Deprecated.  
 EJBMapFunctionality getMapFunctionality()
          Deprecated.  
 EJBMapResource getResource()
          Deprecated.  Returns the GISResource associated with this functionality.
 void initFunctionality(GISResource resource)
          Deprecated.  The initialization chores for the functionality must be performed in this method.
 void setCustomLayerContentClassName(java.lang.String customLayerContentClassName)
          Deprecated.  
 void updateLayerVisibilities()
          Deprecated.  
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ejbMapResource

protected EJBMapResource ejbMapResource
Deprecated. 

customLayerContentClassName

protected java.lang.String customLayerContentClassName
Deprecated. 

customLayerContentClass

protected java.lang.Class customLayerContentClass
Deprecated. 

placeHolderNodeContent

protected static final TocNodeContent placeHolderNodeContent
Deprecated. 
Constructor Detail

EJBTocFunctionality

public EJBTocFunctionality()
Deprecated. 
Method Detail

initFunctionality

public void initFunctionality(GISResource resource)
Deprecated. 
Description copied from interface: GISFunctionality

The initialization chores for the functionality must be performed in this method. This method is called by the resource when the functionality needs to be initialized. This happens either when the resource itself is being initialized or if users add this functionality to the resource using the GISResource.addFunctionality(String, GISFunctionality) method after the resource has already been initialized.

Classes which implement this method should maintain the resource as a class instance variable and return the same in the GISFunctionality.getResource() method. The functionality is ready for use only after this method has been called.

Specified by:
initFunctionality in interface GISFunctionality
Parameters:
resource - the GISResource that this functionality supports
See Also:
GISResource.init(WebContext)

destroyFunctionality

public void destroyFunctionality()
Deprecated. 
Description copied from interface: GISFunctionality

The cleanup chores (such as releasing held resources) for the functionality must be performed in this method. This method is called by the GISResource when the resource itself is being destroyed.

The functionality is no longer usable after this method has been called.

Specified by:
destroyFunctionality in interface GISFunctionality
See Also:
GISResource.destroy()

createTocHierarchy

public void createTocHierarchy(TocNode parentNode)
Deprecated. 
Description copied from interface: TocFunctionality

Creates the content hierarchy for this TOC.

The content generated should be structured as a tree of TocNodes. The WebToc calls this method on each TOC functionality when it first creates the TOC hierarchy. It passes the TocNode representing the node for the resource of the functionality to this method. The TOC functionality is reponsible for generating its content as children nodes of this resource node.

Specified by:
createTocHierarchy in interface TocFunctionality
Parameters:
parentNode - the parent TocNode for the content generated by this TOC functionality

getMapFunctionality

public EJBMapFunctionality getMapFunctionality()
Deprecated. 

getCustomLayerContentClassName

public java.lang.String getCustomLayerContentClassName()
Deprecated. 

setCustomLayerContentClassName

public void setCustomLayerContentClassName(java.lang.String customLayerContentClassName)
Deprecated. 

getResource

public EJBMapResource getResource()
Deprecated. 
Description copied from interface: GISFunctionality

Returns the GISResource associated with this functionality.

The resource passed to GISFunctionality.initFunctionality(GISResource) is maintained as a class variable and is accessible through this method.

Specified by:
getResource in interface GISFunctionality
Returns:
the GISResource associated with this functionality

updateLayerVisibilities

public void updateLayerVisibilities()
Deprecated. 

addPatches

public void addPatches(TocNode node,
                       int layerId)
                throws java.lang.Exception
Deprecated. 
Throws:
java.lang.Exception