Class ExcelFixture

  • All Implemented Interfaces:
    org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScriptWithExecutionStrategy

    @Named("causeway.ext.excel.ExcelFixture")
    public class ExcelFixture
    extends org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScript
    implements org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScriptWithExecutionStrategy
    Since:
    2.0 {@index}
    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScript

        org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScript.ExecutionContext
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String LOGICAL_TYPE_NAME  
      • Fields inherited from class org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScript

        factoryService, NOOP, PATH_SEPARATOR, serviceInjector, serviceRegistry, transactionService, txMan, userService, wrapperFactory
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object o)  
      protected void execute​(org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScript.ExecutionContext ec)  
      org.apache.causeway.applib.value.Blob getBlob()
      Input, mandatory ...
      URL getExcelResource()
      Input, mandatory ...
      String getExcelResourceName()
      Input, optional: defines the name of the resource, used as a suffix to override getQualifiedName() (disambiguate items when added to FixtureResultList if multiple instances of ExcelFixture are used with different excel spreadsheets).
      org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScripts.MultipleExecutionStrategy getMultipleExecutionStrategy()  
      List getObjects()
      Output: all the objects created by this fixture.
      Map<Class<?>,​List<Object>> getObjectsByClass()
      Output: the objects created by this fixture, for a specific persistable/row handler class.
      String getQualifiedName()  
      int hashCode()  
      void setBlob​(org.apache.causeway.applib.value.Blob blob)
      Input, mandatory ...
      void setExcelResource​(URL excelResource)
      Input, mandatory ...
      void setExcelResourceName​(String excelResourceName)
      Input, optional: defines the name of the resource, used as a suffix to override getQualifiedName() (disambiguate items when added to FixtureResultList if multiple instances of ExcelFixture are used with different excel spreadsheets).
      • Methods inherited from class org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScript

        checkParam, coalesce, defaultParam, friendlyNameElseDerived, getFriendlyName, getLocalName, getParentPath, getServiceInjector, localNameElseDerived, m, mixin, optionalParam, run, setFriendlyName, setLocalName, setParentPath, transactionTemplate, unwrap, validateRun, w, wm, wrap, wrap, wrapMixin
    • Method Detail

      • getQualifiedName

        public String getQualifiedName()
        Overrides:
        getQualifiedName in class org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScript
      • execute

        protected void execute​(org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScript.ExecutionContext ec)
        Specified by:
        execute in class org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScript
      • getMultipleExecutionStrategy

        public org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScripts.MultipleExecutionStrategy getMultipleExecutionStrategy()
        Specified by:
        getMultipleExecutionStrategy in interface org.apache.causeway.testing.fixtures.applib.fixturescripts.FixtureScriptWithExecutionStrategy
      • getExcelResourceName

        public String getExcelResourceName()
        Input, optional: defines the name of the resource, used as a suffix to override getQualifiedName() (disambiguate items when added to FixtureResultList if multiple instances of ExcelFixture are used with different excel spreadsheets).
      • setExcelResourceName

        public void setExcelResourceName​(String excelResourceName)
        Input, optional: defines the name of the resource, used as a suffix to override getQualifiedName() (disambiguate items when added to FixtureResultList if multiple instances of ExcelFixture are used with different excel spreadsheets).
      • getExcelResource

        public URL getExcelResource()
        Input, mandatory ... the Excel spreadsheet to read.
      • setExcelResource

        public void setExcelResource​(URL excelResource)
        Input, mandatory ... the Excel spreadsheet to read.
      • getBlob

        public org.apache.causeway.applib.value.Blob getBlob()
        Input, mandatory ... the Excel spreadsheet to read.
      • setBlob

        public void setBlob​(org.apache.causeway.applib.value.Blob blob)
        Input, mandatory ... the Excel spreadsheet to read.
      • getObjects

        public List getObjects()
        Output: all the objects created by this fixture.