gemma: pkg/imports/wfsjob.go comparison

comparison pkg/imports/wfsjob.go @ 5601:1222b777f51f

Made golint finally happy.

author	Sascha L. Teichmann <sascha.teichmann@intevation.de>
date	Sat, 06 Aug 2022 02:09:57 +0200
parents	ade07a3f2cfd
children	2dd155cc95ec

comparison

equal deleted inserted replaced

-:9967a78e43f4
+:1222b777f51f
 	"gemma.intevation.de/gemma/pkg/models"
 	"gemma.intevation.de/gemma/pkg/wfs"
 )
 var (
-	ErrFeatureIgnored     = errors.New("feature ignored")
+	// ErrFeatureIgnored indicates if a feature is ignored.
-	ErrFeatureDuplicated  = errors.New("feature duplicated")
+	ErrFeatureIgnored = errors.New("feature ignored")
+	// ErrFeatureDuplicated indicates if a feature is a duplicate.
+	ErrFeatureDuplicated = errors.New("feature duplicated")
+	// ErrFeaturesUnmodified indicates if a feature is unmodified.
 	ErrFeaturesUnmodified = errors.New("features unmodified")
 )
 type (
+	// WFSFeatureConsumer is an interface to model a transactional
+	// handling to create new features.
 	WFSFeatureConsumer interface {
 		Commit() error
 		Rollback() error
 		NewFeature() (kind string, properties interface{})
 		Consume(geom, properties interface{}, epsg int) error
 	}
+	// WFSFeatureJobCreator is a factory to create feature consumers.
 	WFSFeatureJobCreator struct {
 		description string
 		depends     [2][]string
 		newConsumer func(context.Context, *sql.Conn, Feedback) (WFSFeatureConsumer, error)
 		stageDone func(context.Context, *sql.Tx, int64, Feedback) error
 	}
+	// WFSFeatureJob is job to do an WFS import.
 	WFSFeatureJob struct {
 		models.WFSImport
 		creator *WFSFeatureJobCreator
 	}
 )
 			return &multiLineSlice{*x.(*lineSlice)}
 		},
 	}
 )
+// Description gives a short description of this creator.
 func (wfjc *WFSFeatureJobCreator) Description() string {
 	return wfjc.description
 }
+// Depends lists the dependencies of this creator.
 func (wfjc *WFSFeatureJobCreator) Depends() [2][]string {
 	return wfjc.depends
 }
+// AutoAccept auto accepts this job if there
+// is no stageDone implementation.
 func (wfjc *WFSFeatureJobCreator) AutoAccept() bool {
 	return wfjc.stageDone == nil
 }
+// StageDone forwards the StageDone call.
 func (wfjc *WFSFeatureJobCreator) StageDone(
 	ctx context.Context,
 	tx *sql.Tx,
 	id int64,
 	feedback Feedback,
 		return nil
 	}
 	return wfjc.stageDone(ctx, tx, id, feedback)
 }
+// Create creates the WFS job.
 func (wfjc *WFSFeatureJobCreator) Create() Job {
 	return &WFSFeatureJob{creator: wfjc}
 }
 // Description gives a short info about relevant facts of this import.
 // CleanUp for WFS imports is a NOP.
 func (*WFSFeatureJob) CleanUp() error {
 	return nil
 }
+// Do implements the actual WFS import.
 func (wfj *WFSFeatureJob) Do(
 	ctx context.Context,
 	importID int64,
 	conn *sql.Conn,
 	feedback Feedback,
 	}
 	return nil, err
 }
-type (
+// SQLGeometryConsumer stores a WFS feature into the DB.
-	SQLGeometryConsumer struct {
+type SQLGeometryConsumer struct {
-		ctx        context.Context
+	ctx        context.Context
-		tx         *sql.Tx
+	tx         *sql.Tx
-		feedback   Feedback
+	feedback   Feedback
-		consume    func(*SQLGeometryConsumer, interface{}, interface{}, int) error
+	consume    func(*SQLGeometryConsumer, interface{}, interface{}, int) error
-		newFeature func() (string, interface{})
+	newFeature func() (string, interface{})
-		preCommit  func(*SQLGeometryConsumer) error
+	preCommit  func(*SQLGeometryConsumer) error
-		savepoint  func(func() error) error
+	savepoint  func(func() error) error
-		stmts      []*sql.Stmt
+	stmts      []*sql.Stmt
-	}
+}
-)
+// Rollback rolls back the database state of this consumer.
 func (sgc *SQLGeometryConsumer) Rollback() error {
 	if tx := sgc.tx; tx != nil {
 		sgc.releaseStmts()
 		sgc.tx = nil
 		sgc.ctx = nil
 		return tx.Rollback()
 	}
 	return nil
 }
+// Commit commits the database changes of this consumer to the database.
 func (sgc *SQLGeometryConsumer) Commit() error {
 	var err error
 	if tx := sgc.tx; tx != nil {
 		if sgc.preCommit != nil {
 			err = sgc.preCommit(sgc)
 		}
 	}
 	return err
 }
+// NewFeature forwards the feature creation.
 func (sgc *SQLGeometryConsumer) NewFeature() (string, interface{}) {
 	return sgc.newFeature()
 }
+// Consume forwards the consumption of the given feature.
 func (sgc *SQLGeometryConsumer) Consume(
 	geom, properties interface{},
 	epsg int,
 ) error {
 	return sgc.consume(sgc, geom, properties, epsg)
 }
+// ConsumePolygon forwards the consumption of a polygon.
 func (sgc *SQLGeometryConsumer) ConsumePolygon(
 	polygon polygonSlice,
 	properties interface{},
 	epsg int,
 ) error {

Mercurial > gemma

comparison pkg/imports/wfsjob.go @ 5601:1222b777f51f