Java Doc for Layer.java in » GIS » udig-1.1 » net » refractions » udig » project » internal » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » GIS » udig 1.1 » net.refractions.udig.project.internal

Source Cross Reference Class Diagram Java Document (Java Doc)

net.refractions.udig.project.internal .Layer

All known Subclasses:   net.refractions.udig.project.internal .LayerDecorator,  net.refractions.udig.project.internal.impl .LayerImpl,
Layer
public interface Layer extends EObject,ILayer,IAdaptable,IBlockingAdaptable,IResolveChangeListener(Code)
Read/Write interface for layers
author:
   Jesse
since:
   1.0.0

Field Summary
String copyright


Method Summary
CoordinateReferenceSystem getCRS(IProgressMonitor monitor)
     Gets the CRS for the layer.
CoordinateReferenceSystem getCRS()
     A convenience method for getCRS(null).
CatalogRef getCatalogRef()
     Returns the layer reference information..
ColourScheme getColourScheme()

public ContextModel getContextModel()

Color getDefaultColor()

List<FeatureEvent> getFeatureChanges()
     Returns a list of all the FeatureEvents since the last commit.
Filter getFilter()
     Filter indicating the selected features.
In order for this value to be useful the layer should be selectable, often a single fid filter during user edit opperations.

Note: Filter.ALL indicates no selected Features.
public IGeoResource getGeoResource()
     Returns the currently preferred.
public List<IGeoResource> getGeoResources()
     Access to resources that hold data for this layer.
public ImageDescriptor getGlyph()
     ImageDescriptor for this Layer.
public URL getID()

Map getMapInternal()
     Gets Containing Map.
public double getMaxScaleDenominator()

public double getMinScaleDenominator()

public String getName()
     Gets the name from the associated metadata.
IBlackboard getProperties()
     Temporary layer properties, used for lightweight collaboration.
public Query getQuery(boolean selection)
     Query that selects all the features for the layer.
The selected flag is used with respect to getFilter() :

false : Query for layers contents
true : Query for the layer's selected features

Parameters:
  layer - The layer the Query is associated with.
Parameters:
  selection - true will return a query for the selected features.
public int getStatus()
     Indication of Layer status.
public StyleBlackboard getStyleBlackboard()
     StyleBlackboard used to persist user supplied appearance settings.
This method forms part of the EMF model of a Layer, client code should use style().
public int getZorder()

public boolean isSelectable()
     Indicates this layer is capable of selectable.
A Selectable Layer can be used with the Utilities.getQuery opperation.
public boolean isVisible()

public void setApplicable(String toolCategoryId, boolean isApplicable)
     Set toolset applicability.
public void setBounds(ReferencedEnvelope bounds)
     Sets the spatial bounds of this layer.
void setCRS(CoordinateReferenceSystem value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getCRS CRS ' attribute.
void setCatalogRef(CatalogRef value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getCatalogRef Catalog Ref ' attribute.
void setColourScheme(ColourScheme value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getColourScheme Colour Scheme ' attribute.
void setContextModel(ContextModel value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getContextModel Context Model ' container reference.
void setDefaultColor(Color value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getDefaultColor Default Color ' attribute.
void setFilter(Filter value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getFilter Filter ' attribute.
void setGeoResource(IGeoResource value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getGeoResource Geo Resource ' attribute.
void setGlyph(ImageDescriptor value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getGlyph Glyph ' attribute.
void setID(URL value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getID ID ' attribute.
public void setMaxScaleDenominator(double value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getMaxScaleDenominator Max Scale Denominator ' attribute.
public void setMinScaleDenominator(double value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getMinScaleDenominator Min Scale Denominator ' attribute.
void setName(String value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getName Name ' attribute.
void setSelectable(boolean value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.isSelectable Selectable ' attribute. Used by the user to control which layers are selectable, may be ignored for GeoResources that do not support editing.
void setStatus(int value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getStatus Status ' attribute.
void setStatusMessage(String message)

void setStyleBlackboard(StyleBlackboard value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getStyleBlackboard Style Blackboard ' containment reference.
void setVisible(boolean value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.isVisible Visible ' attribute.
void setZorder(int value)
     Sets the value of the ' net.refractions.udig.project.internal.Layer.getZorder Zorder ' attribute.

Field Detail
copyright
String copyright(Code)

Method Detail
getCRS
CoordinateReferenceSystem getCRS(IProgressMonitor monitor)(Code)
Gets the CRS for the layer. NOTE: THIS METHOD MAY BLOCK!!!
Parameters:
  monitor - may be null. the CoordinateReferenceSystem of the layer or if the CRS cannot be determined. thecurrent map's CRS will be returned, or if this fails the CRS will be WGS84.

getCRS
CoordinateReferenceSystem getCRS()(Code)
A convenience method for getCRS(null). Logs any exceptions with the Plugin log.
This method also allows the CRS to be viewed as an attribute by EMF so ui components and events can be raised. This method may block.
the CoordinateReferenceSystem of the layer or if the CRS cannot be determined.

getCatalogRef
CatalogRef getCatalogRef()(Code)
Returns the layer reference information..

getColourScheme
ColourScheme getColourScheme()(Code)

getContextModel
public ContextModel getContextModel()(Code)
Returns the owning ContextModel object the owning ContextModel object

getDefaultColor
Color getDefaultColor()(Code)

getFeatureChanges
List<FeatureEvent> getFeatureChanges()(Code)
Returns a list of all the FeatureEvents since the last commit. a list of all the FeatureEvents since the last commit.

getFilter
Filter getFilter()(Code)
Filter indicating the selected features.
In order for this value to be useful the layer should be selectable, often a single fid filter during user edit opperations.

Note: Filter.ALL indicates no selected Features. (All features are filtered out)

A tool may wish to record the previous Filter, before replacing (or adding to) this value.
XXX: Consider making use of the General Purpose Blackboard Filter indicating the selected features. Filter.ALL indicates no selected Features.

getGeoResource
public IGeoResource getGeoResource()(Code)
Returns the currently preferred.

getGeoResources
public List<IGeoResource> getGeoResources()(Code)
Access to resources that hold data for this layer.
See Also:    resources() for type safe access IGeoResources that can used to obtain layer data

getGlyph
public ImageDescriptor getGlyph()(Code)
ImageDescriptor for this Layer.
Note we need to do the decorator exention on Layer to reflect status. Custom glyph - or null if none available.

getID
public URL getID()(Code)
Gets the unique id, unique within a context model the id of the layerRef

getMapInternal
Map getMapInternal()(Code)
Gets Containing Map.

getMaxScaleDenominator
public double getMaxScaleDenominator()(Code)

See Also:   ILayer.getMaxScaleDenominator

getMinScaleDenominator
public double getMinScaleDenominator()(Code)

See Also:   ILayer.getMinScaleDenominator

getName
public String getName()(Code)
Gets the name from the associated metadata. the name from the associated metadata

getProperties
IBlackboard getProperties()(Code)
Temporary layer properties, used for lightweight collaboration.
Note these values are not persisted, this can act as a blackboard for plugin collabaration. These properties are not saved and are reset when a map is opened.
If you need long term collaboration we can set up a persistent blackboard in the same manner as StyleBlackbord.

Note: Please don't use this to work around limitations of our object model, instead send email and we can set up a long term solution.
Blackboard used for lightweight collaboration.

getQuery
public Query getQuery(boolean selection)(Code)
Query that selects all the features for the layer.
The selected flag is used with respect to getFilter() :

false : Query for layers contents
true : Query for the layer's selected features

Parameters:
  layer - The layer the Query is associated with.
Parameters:
  selection - true will return a query for the selected features. If selection if false then the features that are not selected are returned, otherwisea query that selects all the selected features is returned.

getStatus
public int getStatus()(Code)
Indication of Layer status.
This is used to provide feedback for a Layers rendering status.

getStyleBlackboard
public StyleBlackboard getStyleBlackboard()(Code)
StyleBlackboard used to persist user supplied appearance settings.
This method forms part of the EMF model of a Layer, client code should use style(). The style() method allows access the StyleBlackboard without being troubled by all the model methods.

See Also:    style();

getZorder
public int getZorder()(Code)

isSelectable
public boolean isSelectable()(Code)
Indicates this layer is capable of selectable.
A Selectable Layer can be used with the Utilities.getQuery opperation. The selection tool category will maintain a separate user interface concept of applicability. The selection tool will not be capabile of considering a non selectable layer applicable.
IMPORTANT FUTURE CHANGE NOTE: future design: Instead of isSelectable and isInfoable a single boolean isApplicable( String toolkitID ) will be used to determine whether the layer is applicable to the current tool cateogry. If the layer is not capable of Each tool category extension will declare a color, which will be an underlay for the layer decorator, and an optional validator class, to determine whether the capability for the layer can be set. Indicates this layer is selectable. true if layer is selectable, false otherwise.

isVisible
public boolean isVisible()(Code)
Returns whether this layer is currently visible whether this layer is currently visible

setApplicable
public void setApplicable(String toolCategoryId, boolean isApplicable)(Code)
Set toolset applicability.
Parameters:
  toolCategoryId - ID of toolset being considered
Parameters:
  isApplicable - true if layer is to be used with indicated toolset

setBounds
public void setBounds(ReferencedEnvelope bounds)(Code)
Sets the spatial bounds of this layer. This property is normally derived from the IGeoResourceInfos, but this provides an override. This will affect the "Zoom to Extent" and "Zoom to Layer" actions.
Parameters:
  bounds - a ReferencedEnvelope indicating the new bounds for the layer

setCRS
void setCRS(CoordinateReferenceSystem value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getCRS CRS ' attribute.
Parameters:
  value - the new value of the 'CRS' attribute.
See Also:   Layer.getCRS()

setCatalogRef
void setCatalogRef(CatalogRef value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getCatalogRef Catalog Ref ' attribute.
Parameters:
  value - the new value of the 'Catalog Ref' attribute.
See Also:   Layer.getCatalogRef()

setColourScheme
void setColourScheme(ColourScheme value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getColourScheme Colour Scheme ' attribute.
Parameters:
  value - the new value of the 'Colour Scheme' attribute.
See Also:   Layer.getColourScheme()

setContextModel
void setContextModel(ContextModel value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getContextModel Context Model ' container reference. TODO: Remove Context Model (1 to 1 relationship does not added anything)
Parameters:
  value - the new value of the 'Context Model' container reference.
See Also:   Layer.getContextModel()

setDefaultColor
void setDefaultColor(Color value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getDefaultColor Default Color ' attribute.
Parameters:
  value - the new value of the 'Default Color' attribute.
See Also:   Layer.getDefaultColor()

setFilter
void setFilter(Filter value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getFilter Filter ' attribute.
Parameters:
  value - the new value of the 'Filter' attribute.
See Also:   Layer.getFilter()

setGeoResource
void setGeoResource(IGeoResource value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getGeoResource Geo Resource ' attribute.
Parameters:
  value - the new value of the 'Geo Resource' attribute.
See Also:   Layer.getGeoResource()

setGlyph
void setGlyph(ImageDescriptor value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getGlyph Glyph ' attribute.
Parameters:
  value - the new value of the 'Glyph' attribute.
See Also:   Layer.getGlyph()

setID
void setID(URL value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getID ID ' attribute.
Parameters:
  value - the new value of the 'ID' attribute.
See Also:   Layer.getID()

setMaxScaleDenominator
public void setMaxScaleDenominator(double value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getMaxScaleDenominator Max Scale Denominator ' attribute.
Parameters:
  value - the new value of the 'Max Scale Denominator' attribute.
See Also:   Layer.getMaxScaleDenominator()

setMinScaleDenominator
public void setMinScaleDenominator(double value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getMinScaleDenominator Min Scale Denominator ' attribute.
Parameters:
  value - the new value of the 'Min Scale Denominator' attribute.
See Also:   Layer.getMinScaleDenominator()

setName
void setName(String value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getName Name ' attribute.
Parameters:
  value - the new value of the 'Name' attribute.
See Also:   Layer.getName()

setSelectable
void setSelectable(boolean value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.isSelectable Selectable ' attribute. Used by the user to control which layers are selectable, may be ignored for GeoResources that do not support editing.
Parameters:
  value - the new value of the 'Selectable' attribute.
See Also:   Layer.isSelectable()

setStatus
void setStatus(int value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getStatus Status ' attribute. Indication of Layer status.
This is used to provide feedback for a Layers rendering status.

See Also:   ILayer.DONE
See Also:   ILayer.ERROR
See Also:   ILayer.MISSING
See Also:   ILayer.UNCONFIGURED
See Also:   ILayer.WARNING
See Also:   ILayer.WORKING
Parameters:
  status - Status should be one of DONE, ERROR, MISSING, UNCONFIGURED, WARNING, WORKING
Parameters:
  value - the new value of the 'Status' attribute.
See Also:   Layer.getStatus()

setStatusMessage
void setStatusMessage(String message)(Code)
Sets the current rendering status message
Parameters:
  message - the status message

setStyleBlackboard
void setStyleBlackboard(StyleBlackboard value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getStyleBlackboard Style Blackboard ' containment reference. Note: The Rendering Process will be restarted as appearance information changes, this is usual limited to a single Layer.
Parameters:
  value - the new value of the 'Style Blackboard' containment reference.
See Also:   Layer.getStyleBlackboard()

setVisible
void setVisible(boolean value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.isVisible Visible ' attribute.
Parameters:
  value - the new value of the 'Visible' attribute.
See Also:   Layer.isVisible()

setZorder
void setZorder(int value)(Code)
Sets the value of the ' net.refractions.udig.project.internal.Layer.getZorder Zorder ' attribute.
Parameters:
  value - the new value of the 'Zorder' attribute.
See Also:   Layer.getZorder()

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.