Class DefaultDriver

    • Constructor Detail

      • DefaultDriver

        protected DefaultDriver​(String name,
                                String description,
                                String title,
                                EnumSet<Driver.DriverCapabilities> driverCapabilities,
                                Hints implementationHints)
    • Method Detail

      • getName

        public String getName()
        Description copied from interface: Driver
        Unique name (non human readable) that can be used to refer to this implementation.

        While the Title and Description will change depending on the users local this name will be consistent. Please note that a given file may be readable by several Drivers (the description of each implementation should be provided to the user so they can make an intellegent choice in the matter).

        Specified by:
        getName in interface Driver
        name of this Driver
      • getTitle

        public InternationalString getTitle()
        Description copied from interface: Driver
        Human readable title for this Driver.
        Specified by:
        getTitle in interface Driver
        human readable title for presentation in user interfaces
      • getImplementationHints

        public Map<RenderingHints.Key,​?> getImplementationHints()
        Implementation hints provided during construction.

        Often these hints are configuration and factory settings used to intergrate the driver with application services.

        Specified by:
        getImplementationHints in interface Factory
        The map of hints, or an {@linkplain java.util.Collections.emptyMap() empty map} if none.
      • getDescription

        public InternationalString getDescription()
        Description copied from interface: Driver
        Describe the nature of this Driver implementation.

        A description of this Driver type; the description should indicate the format or service being made available in human readable terms.

        Specified by:
        getDescription in interface Driver
        A human readable description that is suitable for inclusion in a list of available Drivers.
      • getConnectParameterInfo

        protected Map<String,​Parameter<?>> getConnectParameterInfo()
      • getDeleteParameterInfo

        protected Map<String,​Parameter<?>> getDeleteParameterInfo()
      • getCreateParameterInfo

        protected Map<String,​Parameter<?>> getCreateParameterInfo()
      • canConnect

        protected boolean canConnect​(Map<String,​Serializable> params)
      • canCreate

        protected boolean canCreate​(Map<String,​Serializable> params)
      • canDelete

        protected boolean canDelete​(Map<String,​Serializable> params)
      • defineConnectParameterInfo

        protected Map<String,​Parameter<?>> defineConnectParameterInfo()
      • defineCreateParameterInfo

        protected Map<String,​Parameter<?>> defineCreateParameterInfo()
      • defineDeleteParameterInfo

        protected Map<String,​Parameter<?>> defineDeleteParameterInfo()
      • isAvailable

        public boolean isAvailable()
        Description copied from interface: Driver
        Test to see if this Driver is available, if it has all the appropriate dependencies (jars or libraries).

        One may ask how this is different than #canConnect(Map), and basically available can be used by finder mechanisms to list available Drivers.

        Specified by:
        isAvailable in interface Driver
        Specified by:
        isAvailable in interface OptionalFactory
        true if and only if this factory has all the appropriate dependencies on the classpath to create DataStores.