Class GeneratedSolrSort

All Implemented Interfaces:
Serializable, Comparable
Direct Known Subclasses:
SolrSort

public abstract class GeneratedSolrSort extends GenericItem
Generated class for type SolrSort.
See Also:
  • Field Details

  • Constructor Details

    • GeneratedSolrSort

      public GeneratedSolrSort()
  • Method Details

    • getDefaultAttributeModes

      protected Map<String,Item.AttributeMode> getDefaultAttributeModes()
      Overrides:
      getDefaultAttributeModes in class Item
    • getCode

      public String getCode(SessionContext ctx)
      Generated method - Getter of the SolrSort.code attribute.
      Returns:
      the code - The unique code used to identify the solr sort.
    • getCode

      public String getCode()
      Generated method - Getter of the SolrSort.code attribute.
      Returns:
      the code - The unique code used to identify the solr sort.
    • setCode

      public void setCode(SessionContext ctx, String value)
      Generated method - Setter of the SolrSort.code attribute.
      Parameters:
      value - the code - The unique code used to identify the solr sort.
    • setCode

      public void setCode(String value)
      Generated method - Setter of the SolrSort.code attribute.
      Parameters:
      value - the code - The unique code used to identify the solr sort.
    • createItem

      protected Item createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) throws JaloBusinessException
      Description copied from class: Item
      Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

      In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
      Sn example:

      
       public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
       ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
       man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
       // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
       SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
       super.getNonInitialAttributes( ctx, allAttributes );
       // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }
      
       
      Overrides:
      createItem in class GenericItem
      Parameters:
      ctx - the current session context which this item is created within
      type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )
      Returns:
      the new item instance
      Throws:
      JaloBusinessException - indicates an error during creation - any changes will be rollbacked
    • getFields

      public List<SolrSortField> getFields(SessionContext ctx)
      Generated method - Getter of the SolrSort.fields attribute.
      Returns:
      the fields
    • getFields

      public List<SolrSortField> getFields()
      Generated method - Getter of the SolrSort.fields attribute.
      Returns:
      the fields
    • setFields

      public void setFields(SessionContext ctx, List<SolrSortField> value)
      Generated method - Setter of the SolrSort.fields attribute.
      Parameters:
      value - the fields
    • setFields

      public void setFields(List<SolrSortField> value)
      Generated method - Setter of the SolrSort.fields attribute.
      Parameters:
      value - the fields
    • addToFields

      public void addToFields(SessionContext ctx, SolrSortField value)
      Generated method - Adds value to fields.
      Parameters:
      value - the item to add to fields
    • addToFields

      public void addToFields(SolrSortField value)
      Generated method - Adds value to fields.
      Parameters:
      value - the item to add to fields
    • removeFromFields

      public void removeFromFields(SessionContext ctx, SolrSortField value)
      Generated method - Removes value from fields.
      Parameters:
      value - the item to remove from fields
    • removeFromFields

      public void removeFromFields(SolrSortField value)
      Generated method - Removes value from fields.
      Parameters:
      value - the item to remove from fields
    • getIndexedType

      public SolrIndexedType getIndexedType(SessionContext ctx)
      Generated method - Getter of the SolrSort.indexedType attribute.
      Returns:
      the indexedType
    • getIndexedType

      public SolrIndexedType getIndexedType()
      Generated method - Getter of the SolrSort.indexedType attribute.
      Returns:
      the indexedType
    • setIndexedType

      public void setIndexedType(SessionContext ctx, SolrIndexedType value)
      Generated method - Setter of the SolrSort.indexedType attribute.
      Parameters:
      value - the indexedType
    • setIndexedType

      public void setIndexedType(SolrIndexedType value)
      Generated method - Setter of the SolrSort.indexedType attribute.
      Parameters:
      value - the indexedType
    • getName

      public String getName(SessionContext ctx)
      Generated method - Getter of the SolrSort.name attribute.
      Returns:
      the name - The display name for this sort.
    • getName

      public String getName()
      Generated method - Getter of the SolrSort.name attribute.
      Returns:
      the name - The display name for this sort.
    • getAllName

      public Map<Language,String> getAllName(SessionContext ctx)
      Generated method - Getter of the SolrSort.name attribute.
      Returns:
      the localized name - The display name for this sort.
    • getAllName

      public Map<Language,String> getAllName()
      Generated method - Getter of the SolrSort.name attribute.
      Returns:
      the localized name - The display name for this sort.
    • setName

      public void setName(SessionContext ctx, String value)
      Generated method - Setter of the SolrSort.name attribute.
      Parameters:
      value - the name - The display name for this sort.
    • setName

      public void setName(String value)
      Generated method - Setter of the SolrSort.name attribute.
      Parameters:
      value - the name - The display name for this sort.
    • setAllName

      public void setAllName(SessionContext ctx, Map<Language,String> value)
      Generated method - Setter of the SolrSort.name attribute.
      Parameters:
      value - the name - The display name for this sort.
    • setAllName

      public void setAllName(Map<Language,String> value)
      Generated method - Setter of the SolrSort.name attribute.
      Parameters:
      value - the name - The display name for this sort.
    • isUseBoost

      public Boolean isUseBoost(SessionContext ctx)
      Generated method - Getter of the SolrSort.useBoost attribute.
      Returns:
      the useBoost - The property specifies whether a sort should apply SOLR boost rules.
    • isUseBoost

      public Boolean isUseBoost()
      Generated method - Getter of the SolrSort.useBoost attribute.
      Returns:
      the useBoost - The property specifies whether a sort should apply SOLR boost rules.
    • isUseBoostAsPrimitive

      public boolean isUseBoostAsPrimitive(SessionContext ctx)
      Generated method - Getter of the SolrSort.useBoost attribute.
      Returns:
      the useBoost - The property specifies whether a sort should apply SOLR boost rules.
    • isUseBoostAsPrimitive

      public boolean isUseBoostAsPrimitive()
      Generated method - Getter of the SolrSort.useBoost attribute.
      Returns:
      the useBoost - The property specifies whether a sort should apply SOLR boost rules.
    • setUseBoost

      public void setUseBoost(SessionContext ctx, Boolean value)
      Generated method - Setter of the SolrSort.useBoost attribute.
      Parameters:
      value - the useBoost - The property specifies whether a sort should apply SOLR boost rules.
    • setUseBoost

      public void setUseBoost(Boolean value)
      Generated method - Setter of the SolrSort.useBoost attribute.
      Parameters:
      value - the useBoost - The property specifies whether a sort should apply SOLR boost rules.
    • setUseBoost

      public void setUseBoost(SessionContext ctx, boolean value)
      Generated method - Setter of the SolrSort.useBoost attribute.
      Parameters:
      value - the useBoost - The property specifies whether a sort should apply SOLR boost rules.
    • setUseBoost

      public void setUseBoost(boolean value)
      Generated method - Setter of the SolrSort.useBoost attribute.
      Parameters:
      value - the useBoost - The property specifies whether a sort should apply SOLR boost rules.